upm/docs/contributions.md

Contributing a module {#contributions}

Here are the rules of contribution:

• Your 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 : Some decent description
• You must license your module under a FOSS license. The recommended license 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 LICENSE file in src/mymodule/
• Please test your module builds before contributing and make sure it works on the latest version of mraa. If you tested on a specific board/platform please tell us what this was in your PR.
• Try not to break master. In any commit.
• Attempt to have some decent API documentation below are the explicit rules on documentation:

Documentation

• Try to have no warnings in doxygen, this is generally fairly easy
• Have the specific sensor manufacturer/model & version that you used, if you support multiple versions please list
• Comments do not need full stops
• Stick to <80 chars per line even in comments
• No text is allowed on the same line as the start or end of a comment /** */
• All classes should have a “@brief” and a “@snippet”

The example should have an ‘Interesting’ section which will be highlighted as a code sample in doxygen. Everything in between such tags will show up in the class documentation when the following is put at the end of a class docstring as show above.

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.