2014-06-13 11:53:51 +01:00
|
|
|
Contributing a module {#contributions}
|
|
|
|
=====================
|
|
|
|
|
|
|
|
Here are the rules of contribution:
|
2015-02-27 17:29:23 -08:00
|
|
|
- Your new module must have an example that builds against your UPM library.
|
|
|
|
- Commits must have a sign-off line by everyone who reviewed them.
|
|
|
|
- **Commits must be named <file/module>: Some decent description.**
|
2014-08-07 19:15:32 +01:00
|
|
|
- You must license your module under a FOSS license. The recommended license
|
2014-06-13 11:53:51 +01:00
|
|
|
is MIT but any permissive license is fine. Please consider that people using
|
|
|
|
UPM may want to write proprietary programs with your sensors so we like to
|
|
|
|
avoid GPL. (LGPL is fine). If your license is not MIT please include a
|
2015-02-27 17:29:23 -08:00
|
|
|
LICENSE file in src/mymodule/.
|
2014-06-13 11:53:51 +01:00
|
|
|
- Please test your module builds before contributing and make sure it works on
|
2014-06-25 10:05:27 +01:00
|
|
|
the latest version of mraa. If you tested on a specific board/platform please
|
2014-06-13 11:53:51 +01:00
|
|
|
tell us what this was in your PR.
|
2014-08-07 19:15:32 +01:00
|
|
|
- Try not to break master. In any commit.
|
2015-02-27 17:29:23 -08:00
|
|
|
- Attempt to have some decent API documentation as described in the the @ref
|
|
|
|
documentation [guide](documentation.md).
|
2014-06-13 11:53:51 +01:00
|
|
|
|
2014-12-15 16:23:59 +00:00
|
|
|
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 <random@developer.example.org>
|
|
|
|
|
|
|
|
using your real name (sorry, no pseudonyms or anonymous contributions.)
|
|
|
|
Unsigned commits will not be accepted.
|