Contributor Guidelines

If you’re here, it’s hopefully because you’re looking to contribute code to one (or more!) of our projects. We’d just like to extend a heartfelt ’thank you’ in advance, we appreciate any and all contributions.

Contributing to any of our projects requires agreeing to the Developer Certificate of Origin (DCO), which consists of signing-off on the commits in your PR. This can be done with git commit -s, or by appending the following to your commit message:

Signed-off-by: $FULL_NAME <$EMAIL>

where $FULL_NAME and $EMAIL should be replaced by your full name and email address, respectively. These should match what is in your GitHub profile. This will be enforced by Continuous Integration (CI).

Potential contributors should read through the full text of the DCO, it’s quite short and accessible to non-lawyers. The gist is that any contributions made are being offered under the same license as the project (usually MIT in our case), and contributors are only contributing things they have the right to contribute (e.g. nothing stolen or inappropriately licensed).