upm/docs/contributions.md

Contributing a module

Here are the rules of contribution:

• Your new module must have an example that builds against your UPM library.
• Each commit must have a sign-off line by everyone who authored or reviewed them.
• Commits must be named <file/module>: 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. If your license is not MIT please include a LICENSE file in src/mymodule/.
• The top of each source file must contain a comment block containing the license information.
• Please test your module builds before contributing and make sure it works on the latest version of libmraa. 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 as described in the the @ref documentation guide.

Including the MIT license

Choosing the MIT license is preferred for the UPM repository. Below is the comment block needed at the top each source file:

    /*
     * The MIT License (MIT)
     *
     * Author: <your full name> 
     * Copyright (c) <year> <copyright holder>
     *
     * Author: <contributing author full name - if applicable> 
     * Copyright (c) <year> <copyright holder>
     *
     * Permission is hereby granted, free of charge, to any person obtaining a copy of
     * this software and associated documentation files (the "Software"), to deal in
     * the Software without restriction, including without limitation the rights to
     * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
     * the Software, and to permit persons to whom the Software is furnished to do so,
     * subject to the following conditions:
     *
     * The above copyright notice and this permission notice shall be included in all
     * copies or substantial portions of the Software.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
     * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
     * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
     * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
     * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     */

Eclipse Contributor Agreement

Your contribution cannot be accepted unless you have a signed ECA - Eclipse Foundation Contributor Agreement in place.

Here is the checklist for contributions to be considered acceptable:

1. Create an account at Eclipse.
2. Add your GitHub user name in your account settings.
3. Log into the project's portal and sign the "Eclipse ECA".
4. Ensure that you sign-off your Git commits.
5. Ensure that you use the same email address as your Eclipse account in commits.
6. Include the appropriate copyright notice and license at the top of each file.

Your signing of the ECA will be verified by a webservice called 'ip-validation' that checks the email address that signed-off on your commits has signed the ECA. Note: This service is case-sensitive, so ensure the email that signed the ECA and that signed-off on your commits is the same, down to the case.

Creating a new sensor library using the sensortemplate

A stubbed-out sensor library is available which can be leveraged to get up-and-running quickly when writing a new sensor library. Use the shell commands below to generate collateral files for your new sensor library.

#!/bin/bash

function make_new_sensor {
    export SensorName=$1
    # Get a lowercase version of the string
    export sensorname=${SensorName,,}

    # Make sure this is run from the root UPM directory
    if ! grep -q 'UPM ' README.md; then echo "Please run from the root UPM directory"; return -1; fi

    printf "Generating new sensor: ${SensorName}\n"
    # Copy sensortemplate files to ${sensorname}
    find docs/ examples/ src/ -name '*sensortemplate*' -exec bash -c 'cp -r $0 ${0/sensortemplate/${sensorname}}' {} \;
    # Copy SensorTemplate files to ${SensorName}
    find examples/ src/ -name '*SensorTemplate*' -exec bash -c 'cp -r $0 ${0/SensorTemplate/${SensorName}}' {} \;
    # Rename sernsortemplate src files
    rename "s/sensortemplate/${sensorname}/" src/${sensorname}/*
    # Search/replace the new files, replacing all instances of sensortemplate
    perl -p -i -e "s/SensorTemplate/${SensorName}/g" src/${sensorname}/* examples/*/*${sensorname}* examples/*/*${SensorName}*
    perl -p -i -e "s/sensortemplate/${sensorname}/g" src/${sensorname}/* examples/*/*${sensorname}* examples/*/*${SensorName}*
    # Remove objects starting with "//" from the new library descriptor .json file
    perl -p -i -e 'BEGIN{undef $/;} s/\s+"\/\/.*?},//smg' src/${sensorname}/${sensorname}.json
    # Add mynewmodule example target for java
    perl -p -i -e "s/^((.*)SensorTemplateSample sensortemplate(.*))/\1\n\2${SensorName}Sample ${sensorname}\3/g" examples/java/CMakeLists.txt
    # Add mynewmodule example mappings for doxygen
    perl -p -i -e "s/^(.*SensorTemplateSample.*)$/\1\n${sensorname}.cxx\t${SensorName}Sample.java\t${sensorname}.js\t${sensorname}.py/g" doxy/samples.mapping.txt
    # Display TODO's
    printf "Generation complete for sensor library: ${SensorName}\n"
    printf "TODO's:\n"
    printf "\t1. Update src/hdr files: src/${sensorname}/${sensorname}.hpp src/${sensorname}/${sensorname}.cxx\n"
    printf "\t\tChange the Author\n"
    printf "\t\tChange the Copyright\n"
    printf "\t\tUpdate all doxygen tags (follow directions for @tags)\n"
    printf "\t2. Update examples: examples/*/${sensorname}.* examples/java/*${SensorName}*.java\n"
    printf "\t3. Overwrite docs/images/${sensorname}.png with a valid image of your sensor\n"
}

# Call make_new_sensor with your new sensor name, example: 'MyNewSensor1234'
make_new_sensor MyNewSensor1234

Once all files have been created, they can be used as a starting-point for your new library. They will need additional customization (your name/email address, documentation, sensor images, etc).