Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.17 KB

File metadata and controls

27 lines (17 loc) · 1.17 KB

Contributing to Our Project

First off, thank you for considering contributing! It's people like you that make the open source community such an amazing place.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with the title [Enhancement] Your Suggestion Title.
  • Provide a clear and detailed explanation of the feature you'd like to see, why it's useful, and if possible, a use-case.

Pull Requests

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.