We'd love to accept your patches and contributions to this project. There are just a few guidelines you need to follow which are described in detail below.
You should create a fork of this project in your account and work from there. You can create a fork by clicking the fork button in GitHub.
Work for each new feature/issue should occur in its own branch. To create a new branch from the command line:
git checkout -b my-new-feature
where "my-new-feature" describes what you're working on.
- Please review the README.md file in this project to see if they are impacted by your change and update them accordingly.
- If you've changed or added directories, make sure to provide or update their internal README file.
- Once finished, make sure to create a dedicated pull request in the example branch, updating according to your change.
Any notable changes should be recorded in the CHANGELOG.md following the Keep a Changelog conventions.
Push your changes to your branch and open a pull request against the parent repo on GitHub. The project administrators will review your pull request and respond with feedback.
Upon pull request submission, your code will be reviewed by the maintainers. They will confirm that contribution policy has been followed.
A (human) reviewer will need to sign off on your pull request before it can be merged.