|
| 1 | +Contributing to TinyB {#contributing} |
| 2 | +====================== |
| 3 | + |
| 4 | +TinyB is an opensource project and we are actively looking for people to help |
| 5 | +with: |
| 6 | + |
| 7 | +- Contributions to functionality, extensions of API |
| 8 | +- Use and test the library, provide bug reports where appropiate |
| 9 | +- Help spread the word about this library to people who might need it |
| 10 | +- Other ideas are always welcome |
| 11 | + |
| 12 | +The recommended method to contribute is to fork on github, and then send pull |
| 13 | +requests to the main project. You can open issues if you find any bugs/have |
| 14 | +questions. |
| 15 | + |
| 16 | +If you'd rather not use github you are more than welcome to send git formatted |
| 17 | + |
| 18 | + |
| 19 | +Basic rules |
| 20 | +----------- |
| 21 | +- Your code must build |
| 22 | +- Commits must have a sign-off line by at least yourself |
| 23 | +- Commits must be named <file/module>: Some decent description |
| 24 | +- Try not to break master. In any commit. |
| 25 | +- Try to split commits up logically, you will be asked to rebase them if they |
| 26 | + are not. |
| 27 | +- Try to stick to the established coding style regardless of your personal |
| 28 | + feeling for it! |
| 29 | + |
| 30 | +Code signing |
| 31 | +------------ |
| 32 | + |
| 33 | +The sign-off is a simple line at the end of the explanation for the |
| 34 | +patch, which certifies that you wrote it or otherwise have the right to pass it |
| 35 | +on as an open-source patch. The rules are pretty simple: if you can certify |
| 36 | +the below: |
| 37 | + |
| 38 | + Developer's Certificate of Origin 1.1 |
| 39 | + |
| 40 | + By making a contribution to this project, I certify that: |
| 41 | + |
| 42 | + (a) The contribution was created in whole or in part by me and I |
| 43 | + have the right to submit it under the open source license |
| 44 | + indicated in the file; or |
| 45 | + |
| 46 | + (b) The contribution is based upon previous work that, to the best |
| 47 | + of my knowledge, is covered under an appropriate open source |
| 48 | + license and I have the right under that license to submit that |
| 49 | + work with modifications, whether created in whole or in part |
| 50 | + by me, under the same open source license (unless I am |
| 51 | + permitted to submit under a different license), as indicated |
| 52 | + in the file; or |
| 53 | + |
| 54 | + (c) The contribution was provided directly to me by some other |
| 55 | + person who certified (a), (b) or (c) and I have not modified |
| 56 | + it. |
| 57 | + |
| 58 | + (d) I understand and agree that this project and the contribution |
| 59 | + are public and that a record of the contribution (including all |
| 60 | + personal information I submit with it, including my sign-off) is |
| 61 | + maintained indefinitely and may be redistributed consistent with |
| 62 | + this project or the open source license(s) involved. |
| 63 | + |
| 64 | +then you just add a line saying |
| 65 | + |
| 66 | + Signed-off-by: Random J Developer <[email protected]> |
| 67 | + |
| 68 | +Using your real name (sorry, no pseudonyms or anonymous contributions.) |
0 commit comments