|
@@ -3,14 +3,16 @@ Contributing a module {#contributions}
|
3
|
3
|
|
4
|
4
|
Here are the rules of contribution:
|
5
|
5
|
- Your new module must have an example that builds against your UPM library.
|
6
|
|
-- Each commit must have a sign-off line by everyone who reviewed them.
|
|
6
|
+- Each commit must have a sign-off line by everyone who authored or reviewed
|
|
7
|
+ them.
|
7
|
8
|
- Commits must be named `<file/module>: Some decent description`.
|
8
|
9
|
- You must license your module under a FOSS license. The recommended license
|
9
|
10
|
is MIT but any permissive license is fine. Please consider that people using
|
10
|
11
|
UPM may want to write proprietary programs with your sensors so we like to
|
11
|
12
|
avoid GPL. If your license is not MIT please include a LICENSE file in
|
12
|
13
|
src/mymodule/.
|
13
|
|
-- The top of each source file must contain a comment block containing the license information.
|
|
14
|
+- The top of each source file must contain a comment block containing the
|
|
15
|
+ license information.
|
14
|
16
|
- Please test your module builds before contributing and make sure it works on
|
15
|
17
|
the latest version of libmraa. If you tested on a specific board/platform
|
16
|
18
|
please tell us what this was in your PR.
|