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.
- Fork and clone the repository
- Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- 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.
If you are submitting a patch for a security vulnerability please report it to the bounty tracker
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
- Don't forget about your pull request. If someone comments on your pull request with things you need to do before the pull request can be merged or someone comments some suggestions for your pull request, they probably want a response. If you don't fix issues with your pull request, it probably won't be merged.
- Create a new issue
- Refer to this document if unsure on how to properly create a new issue
- Follow the issue template to provide as much details of your operating system and environment as possible.
- Tell us about what issues you are experiencing.
- Tell us how to reproduce your issue(s)
- Stay active in your issue in case a repository maintainer needs additional information