mirror of
https://github.com/eclipse/upm.git
synced 2025-03-24 01:10:22 +03:00
contributions.md: clarify some details about making a contribution to UPM
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
parent
e2b3cbc0f1
commit
49ce602808
@ -3,13 +3,14 @@ Contributing a module {#contributions}
|
|||||||
|
|
||||||
Here are the rules of contribution:
|
Here are the rules of contribution:
|
||||||
- Your new module must have an example that builds against your UPM library.
|
- 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.
|
- Each commit must have a sign-off line by everyone who reviewed them.
|
||||||
- **Commits must be named <file/module>: Some decent description.**
|
- **Commits must be named <file/module>: Some decent description.**
|
||||||
- You must license your module under a FOSS license. The recommended license
|
- 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
|
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
|
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
|
avoid GPL. (LGPL is fine). If your license is not MIT please include a
|
||||||
LICENSE file in src/mymodule/.
|
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
|
- 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
|
the latest version of libmraa. If you tested on a specific board/platform
|
||||||
please tell us what this was in your PR.
|
please tell us what this was in your PR.
|
||||||
@ -17,6 +18,40 @@ Here are the rules of contribution:
|
|||||||
- Attempt to have some decent API documentation as described in the the @ref
|
- Attempt to have some decent API documentation as described in the the @ref
|
||||||
documentation [guide](documentation.md).
|
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
|
||||||
|
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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
Code signing
|
Code signing
|
||||||
============
|
============
|
||||||
|
|
||||||
@ -51,7 +86,7 @@ the below:
|
|||||||
maintained indefinitely and may be redistributed consistent with
|
maintained indefinitely and may be redistributed consistent with
|
||||||
this project or the open source license(s) involved.
|
this project or the open source license(s) involved.
|
||||||
|
|
||||||
then you just add a line saying
|
then you just add a line to each of your commits with `--signoff` saying
|
||||||
|
|
||||||
Signed-off-by: Random J Developer <random@developer.example.org>
|
Signed-off-by: Random J Developer <random@developer.example.org>
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user