Contributions are welcome and will be fully credited.
We accept contributions via Pull Requests on Github.
Add tests! - Your patch won't be accepted if it doesn't have tests.
Document any change in behaviour - Make sure the
README.mdand any other relevant documentation are kept up-to-date.
Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
Create feature branches - Don't ask us to pull from your master branch.
One pull request per feature - If you want to do more than one thing, send multiple pull requests.
Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
The master branch always contains the most up-to-date, production ready release. In most cases, this will be the same as the latest release under the "releases" tab.
the develop branch holds work in progress for the next release. Any work here should be stable. The idea is that security patches, refactors, and new features are merged into this branch. Once enough patches has been tested here, it will be merged into
master and released. This branch should always be stable.
feature- branches hold in progress work for upcoming features destined for future major or minor releases. These can be unstable.
patch- branches hold in progress patches for upcoming point releases, security patches, and refactors. These can be unstable.
Be sure to fetch often so you keep your sources up-to-date!