Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
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.
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
- Fork and clone the repository.
- Make sure you set up your local development environment as described above.
- Create a new branch:
git checkout -b my-branch-name. - Make your change, add your feature/bug specific tests, and make sure the entire tests suite passes (see above)
- Push to your fork, and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Write and update tests.
- Keep your changes as focused as possible
- Smaller PRs make faster & easier reviews, which make faster acceptance & merges
- Keep each PR focused on one specific change
- Write a good commit message.
- Provide any and all necessary information in the PR description to help reviewers understand the context and impact of your change.
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.