Contribution Guidelines

<h1>Basic Guidelines</h1> It’s awesome you want to pitch in and help, there’s just some few housekeeping things to take care of. The most important of these is helping make sure that patches submitted to the SnapTest project are available to everyone. The very short list of things to be a good contributor is: <ol> <li>Use 4 spaces for tab. Do not submit patches containing tab</li> <li>Use Unix line endings (\n not \r\n)</li> <li>Use K&R style, but do not drop braces ({ or })</li> </ol> The even shorter list of things you MUST do as a contributor is: <ol> <li>Sign off your patches</li> </ol> 4 Spaces for Tab, Unix Line Endings: Being consistent in this just makes the patching process easier. There is less chance of crazy conflicts, and things will display consistently on all screens. Nobody really wants `^M` showing up in their editor all over the place. K&R Style, but do not drop braces({ or }): This is done to support the widest range of editors which use folding. Things simply fold better in more editors, and while the rest of K&R style is solid cross-editor, this is just an annoying quirk. Sign off your patches: Okay, the other two are “nice” to do, but this one is a must. You simply MUST add Signed-off-by: Random J Developer <random@developer.example.org> to a message containing a commit / patch that you wish to contribute to the project. Adding this statement is a signature agreeing to the Developer’s Certificate of Origin, which is hopefully the closest this project ever gets to a CLA. If you don’t include one, it’ll have to be gotten (likely contact via email) to get the necessary permission. If we can’t get the sign off, we can’t include the patch. <h1>Developer’s Certificate of Origin</h1> By making a contribution to this project, I certify that: <ol> <li>The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or</li> <li>The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or</li> <li>The contribution was provided directly to me by some other person who certified (a), (b) or © and I have not modified it.</li> <li>I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.</li> </ol> If you can certify 1, 2, 3, and 4, then you simply need to sign off your commit or the posting containing your patch with `Signed-off-by: Random J Developer <random@developer.example.org>`. If you are using git, then you can simply use the `git commit -s` command. <h1>List of Contributors</h1> A chronological list of contributors can be found on the [[Contributor List]]. 2009-11-27T01:55:51-08:00 266975 contribution-guidelines

1880

2009-07-19T16:52:05-07:00

1795