We gratefully accept contributions via pull requests.
Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this solution.
Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull-request. This is often called the Fork-and-Pull model
-
All contributions to this project will be released under the inbound=outbound norm, that is, they are submitted under the projects main license.
-
By submitting a pull request or filing a bug, issue, or feature request, you agree to comply with this waiver of copyright interest. Details can be found in the LICENSE.
-
All new code should have associated unit tests in some form.
As part of filing a pull request you agree to the DCO. Developer Certificate of Origin
A DCO is a lightweight way for a contributor to confirm that they wrote or otherwise have the right to submit code or documentation to a project.
To confirm that you agree to the DCO, you need to sign off your commits when sending us a pull request. Technically, this is done by supplying the -s
/--signoff
flag to git when committing:
$ git commit -s -m "add fix for the bug"
Optionally, you can also sign the commit with -S
which also gives your commit a nice verified button on GitHub,
It requires that you have a GPG keypair set up, see Sign commit on GitHub with GPG key
$ git commit -s -S -m "add fix for the bug"
For the difference between signoff and signing, see Git signoff vs signing