| ## Contributing |
|
|
| ### Guidelines |
|
|
| Here are a few guidelines for contributing: |
|
|
| * If you would like to contribute to the codebase **please raise an issue to propose the change** |
| * Do not mix feature changes or fixes with refactoring - it makes the code harder to review and means there is more for the maintainers (with limited time) to test |
|
|
| * If you have found a bug please raise an issue and fill out the whole template. |
| * If the documentation can be improved / translated etc please raise an issue to discuss. |
| * Please always provide a summary of what you changed, how you did it and how it can be tested. |
|
|
| ### License |
|
|
| This project is licensed under the GPL3 License. |
|
|
| #### Sign your work |
|
|
| The sign-off is a simple line at the end of the explanation for a patch. Your |
| signature certifies that you wrote the patch or otherwise have the right to pass |
| it on as an open-source patch. The rules are pretty simple: if you can certify |
| the below (from [developercertificate.org](http://developercertificate.org/)): |
|
|
| ``` |
| Developer Certificate of Origin |
| Version 1.1 |
| |
| Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 1 Letterman Drive |
| Suite D4700 |
| San Francisco, CA, 94129 |
| |
| Everyone is permitted to copy and distribute verbatim copies of this |
| license document, but changing it is not allowed. |
| |
| Developer's Certificate of Origin 1.1 |
| |
| By making a contribution to this project, I certify that: |
| |
| (a) 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 |
| |
| (b) 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 |
| |
| (c) The contribution was provided directly to me by some other |
| person who certified (a), (b) or (c) and I have not modified |
| it. |
| |
| (d) 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. |
| ``` |
|
|
| Then you just add a line to every git commit message: |
|
|
| Signed-off-by: Joe Smith <joe.smith@email.com> |
| |
| If you set your `user.name` and `user.email` git configs, you can sign your |
| commit automatically with `git commit -s`. |
|
|
| * Please sign your commits with `git commit -s` so that commits are traceable. |
|
|
