Skip to content

Latest commit

 

History

History
35 lines (18 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

35 lines (18 loc) · 1.93 KB

Contributors welcome!

As the interest in this project rises, I want to give some guidelines on how you can best contribute to this project.

Did you find a bug?

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

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

  • Please propose your change in Github Discussions before you start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about this project?

How do you acknowledge contributions?

  • This project follows the all-contributors guidelines which means all contributors are regognized, not just the ones who push code. We list all contributors in the README.

If you have any idea or concern that doesn't fit into any of the above categories, just send me a private message on twitter.

Thanks! ❤️ ❤️ ❤️

Joost Jansky