Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

33 lines (17 loc) · 1.93 KB
Raw

How to contribute to this project

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability, and instead send an email to [email protected].

  • 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.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of this project will generally not be accepted.

Do you intend to add a new feature or change an existing one?

  • Ensure the change was not already proposed by searching on GitHub under Issues.

  • If you're unable to find an appropriate open issue, 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.

  • Do not start writing code until you have collected positive feedback on the issue 🙂

Do you have questions about the source code?

Thanks! ❤️ ❤️ ❤️