diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 00000000..b2fb88d6 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,44 @@ +# Contributing to Eclipse UPM + +Thanks for your interest in this project. + +## Project description + +The Eclipse UPM repository provides software drivers for a wide variety of +commonly used sensors and actuators. These software drivers interact with the +underlying hardware platform (or microcontroller), as well as with the attached +sensors, through calls to Eclipse MRAA APIs. + +* https://projects.eclipse.org/projects/iot.upm + +## Developer resources + +Information regarding source code management, builds, coding standards, and +more. + +* https://projects.eclipse.org/projects/iot.upm/developer + +The project maintains the following source code repositories + + +## Eclipse Contributor Agreement + +Before your contribution can be accepted by the project team contributors must +electronically sign the Eclipse Contributor Agreement (ECA). + +* http://www.eclipse.org/legal/ECA.php + +Commits that are provided by non-committers must have a Signed-off-by field in +the footer indicating that the author is aware of the terms by which the +contribution has been provided to the project. The non-committer must +additionally have an Eclipse Foundation account and must have a signed Eclipse +Contributor Agreement (ECA) on file. + +For more information, please see the Eclipse Committer Handbook: +https://www.eclipse.org/projects/handbook/#resources-commit + +## Contact + +Contact the project developers via the project's "dev" list. + +* diff --git a/docs/contributions.md b/docs/contributions.md index 72583f17..b9633297 100644 --- a/docs/contributions.md +++ b/docs/contributions.md @@ -1,59 +1,35 @@ Contributing a module {#contributions} ===================== -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 `: 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/. +In order to contribute to the project: - 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. +- Commits must be named `: Some decent description`. +- Each commit must have a sign-off line by everyone who authored or reviewed + them. +- Your new module must have an example that builds against your UPM library. - Attempt to have some decent API documentation as described in the the @ref documentation [guide](documentation.md). Including the MIT license ========================= Choosing the [MIT license](http://opensource.org/licenses/MIT) is preferred for -the UPM repository. Below is the comment block needed at the top each source +the UPM repository. Below is the comment block needed at the top each source file: /* - * The MIT License (MIT) - * - * Author: + * Author: * Copyright (c) * - * Author: + * Author: * Copyright (c) * - * 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: + * This program and the accompanying materials are made available under the + * terms of the MIT License which is available at https://opensource.org/licenses/MIT. * - * 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. + * SPDX-License-Identifier: MIT */ - Eclipse Contributor Agreement ============