We'd love to accept your patches and contributions to this project. Pull requests are part of what makes open source great. There are just a few small guidelines you need to follow.
Participation in this project comes under the Contributor Covenant Code of Conduct
- We follow the Github Pull Request Model for all contributions.
- For large bodies of work, we recommend creating an issue outlining the feature that you wish to build, and describing how it will be implemented. This gives a chance for review to happen early, and ensures no wasted effort occurs.
- All submissions, will require review before being merged.
- Finally - Thanks for considering submitting code to the project!
When submitting pull requests, make sure to do the following:
- Maintain the same code style as the rest of the project.
- Remove trailing whitespace. Many editors will do this automatically.
- Ensure any new files have a trailing newline
- Describe your changes in the CHANGELOG.md (if present).
- Give yourself some credit in the appropriate place (usually the CHANGELOG.md).
- Make commits of logical units.
- Ensure your commit messages help others understand what you are doing and why.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Maintain the same code style.
- Maintain the same level of test coverage or improve it.
- General GitHub documentation
- How to write a good Git Commit message - Great way to make sure your Pull Requests get accepted.
- An Open Source Etiquette Guidebook