Contributions are welcome!
Contributions can be bug reports, feature requests, testing and documentation in addition to code.
Contributions to this project are accepted on an "inbound=outbound" basis. That means that you agree that your contributions are made under the same license as the license for this project (found in this directory in the LICENSE file).
To make this understanding explicit -- and for you to assert that you have the right to make the contribution -- commits must be signed off indicating acceptance of the Developer Certificate of Origin 1.1. A nice explanation of the DCO has been provided by Karl Fogel in his excellent book Producing Open Source Software. An explanation of the "sign-off" procedure is given by Linus Torvalds in Linux.
Please note that this project is released with a Contributor Code of Conduct (adopted from the Contributor Covenant v2.0).
By participating in this project you agree to abide by the Contributor Code of Conduct (please read the full text so that you can understand what actions will and will not be tolerated).
This is an overview of the contribution workflow:
- Clone the repo
- Create a branch
- Make your change
- Make commits to your branch using the following guidelines:
- Start with a subject line (beginning with a capital, ending without a period, no more than 50 characters)
- The second line should be blank
- The body starts on the third line
- Use the imperative mood in the subject line: "Add x", "Fix y", "Support z", "Remove x"
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
- Finish the commit message with the sign off:
Signed-off-by: Your Name <[email protected]>
- Make commits to your branch using the following guidelines:
- Test
- If applicable make sure formatting rules are applied
- Email a patchset to [email protected]
Verifying commits is not essential for contributions to this project, but for those motivated to add additional security it is appreciated.