diff options
author | Petre Eftime <[email protected]> | 2016-05-05 14:31:53 +0300 |
---|---|---|
committer | Petre Eftime <[email protected]> | 2016-05-05 14:31:53 +0300 |
commit | 4e82f20a5d1a7aff80e03bec5770bb27190498eb (patch) | |
tree | d16c69b5afda536f85888b102c6aec44c00a7c69 /CONTRIBUTING.md | |
parent | f5f8c4a87f3963a65c7041fa139800f45e0dc689 (diff) |
README: Add Contribution Guide and update license file
Signed-off-by: Petre Eftime <[email protected]>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e2105116 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,68 @@ +Contributing to TinyB {#contributing} +====================== + +TinyB is an opensource project and we are actively looking for people to help +with: + +- Contributions to functionality, extensions of API +- Use and test the library, provide bug reports where appropiate +- Help spread the word about this library to people who might need it +- Other ideas are always welcome + +The recommended method to contribute is to fork on github, and then send pull +requests to the main project. You can open issues if you find any bugs/have +questions. + +If you'd rather not use github you are more than welcome to send git formatted +patches to [email protected]. + +Basic rules +----------- +- Your code must build +- Commits must have a sign-off line by at least yourself +- Commits must be named <file/module>: Some decent description +- Try not to break master. In any commit. +- Try to split commits up logically, you will be asked to rebase them if they + are not. +- Try to stick to the established coding style regardless of your personal + feeling for it! + +Code signing +------------ + +The sign-off is a simple line at the end of the explanation for the +patch, which certifies that you wrote it 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: + + 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 saying + + Signed-off-by: Random J Developer <[email protected]> + +Using your real name (sorry, no pseudonyms or anonymous contributions.) |