Thank you for your interest in contributing to this project! All types of contributions are encouraged and valued. If you haven't already done so, please take a few minutes to read through the code of conduct and make sure you wholeheartedly agree to abide by it. 💖
Want to contribute some code and/or documentation to this project? That's awesome! Feel free to fork the repo and open a PR with any changes you'd like to propose. And don't worry about your potential contributions being "too small", even if you're just fixing a typo or rewording a sentence to be more clear. Any improvements are welcome and very much appreciated - so thank you in advance!
The pre-commit CI service will run some checks to ensure that your changes keep this project clean, green, and healthy.
- Some failing checks may be automatically fixed by the service, and the resulting changes will be added to your PR as a subsequent commit.
- Some things may require manual fixing. You can make the requested changes in your local copy of the repo, then commit and push to your PR branch again. This will update the PR and trigger a re-run of all the checks.
Once your PR passes all pre-commit checks, a project maintainer will review it.
- If the maintainer asks for any changes: make the necessary edits, commit and push to your PR branch, and then ask for another review. This back-and-forth may happen more than once, especially if your changes are non-trivial.
- If the maintainer decides to pass on your PR, they will thank you for the contribution and explain why they won't be accepting those particular changes. That's okay! We still really appreciate you devoting your time to help improve this project, and hope to see other contributions from you in the future. 💗
- If the maintainer accepts your PR, it will be merged into the repository's
mainbranch. This means that your contribution has officially become part of this project and will be distributed to our users soon! 🎉