Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.69 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project 👍. Please read through this document before submitting issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

Please use GitHub issue tracker to report bugs or suggest features. Include as much information as you can:

  • A reproducible test case or series of steps
  • Any modifications you've made relevant to the bug
  • Details about your environment or deployment that may be applicable

Contributing via Pull Requests

Before sending a pull request, please:

  1. Ensure you are working against the latest source on the master branch.
  2. Check existing open, and recently merged, pull requests to make sure a problem you are trying to solve is not already addressed.
  3. Open an issue to discuss any changes that will require a significant amount of work for development and/or testing or adds a significant amount of complexity.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source. If you are reformatting full classes, please include formatting changes in a commit separate from logic changes.
  3. Ensure local tests pass.
  4. Commit to your fork using clear commit messages and include a link to an issue (if applicable).
  5. Send us a pull request. Answer questions in the pull request interface.
  6. Check for messages from an automated CI process (if applicable). Fix any issues as needed.

Licensing

See the LICENSE file for our project's licensing. Any contributions submitted in a pull request will be under the terms of this licensing without any terms and conditions.