|
1 | 1 | Contributing a module {#contributions}
|
2 | 2 | =====================
|
3 | 3 |
|
4 |
| -Here are the rules of contribution: |
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 authored or reviewed |
7 |
| - them. |
8 |
| -- Commits must be named `<file/module>: Some decent description`. |
9 |
| -- You must license your module under a FOSS license. The recommended license |
10 |
| - is MIT but any permissive license is fine. Please consider that people using |
11 |
| - UPM may want to write proprietary programs with your sensors so we like to |
12 |
| - avoid GPL. If your license is not MIT please include a LICENSE file in |
13 |
| - src/mymodule/. |
| 4 | +In order to contribute to the project: |
14 | 5 | - The top of each source file must contain a comment block containing the
|
15 | 6 | license information.
|
16 |
| -- Please test your module builds before contributing and make sure it works on |
17 |
| - the latest version of libmraa. If you tested on a specific board/platform |
18 |
| - please tell us what this was in your PR. |
19 |
| -- Try not to break master. In any commit. |
| 7 | +- Commits must be named `<file/module>: Some decent description`. |
| 8 | +- Each commit must have a sign-off line by everyone who authored or reviewed |
| 9 | + them. |
| 10 | +- Your new module must have an example that builds against your UPM library. |
20 | 11 | - Attempt to have some decent API documentation as described in the the @ref
|
21 | 12 | documentation [guide](documentation.md).
|
22 | 13 |
|
23 | 14 | Including the MIT license
|
24 | 15 | =========================
|
25 | 16 | Choosing the [MIT license](http://opensource.org/licenses/MIT) is preferred for
|
26 |
| -the UPM repository. Below is the comment block needed at the top each source |
| 17 | +the UPM repository. Below is the comment block needed at the top each source |
27 | 18 | file:
|
28 | 19 |
|
29 | 20 | /*
|
30 |
| - * The MIT License (MIT) |
31 |
| - * |
32 |
| - * Author: <your full name> |
| 21 | + * Author: <your full name> |
33 | 22 | * Copyright (c) <year> <copyright holder>
|
34 | 23 | *
|
35 |
| - * Author: <contributing author full name - if applicable> |
| 24 | + * Author: <contributing author full name - if applicable> |
36 | 25 | * Copyright (c) <year> <copyright holder>
|
37 | 26 | *
|
38 |
| - * Permission is hereby granted, free of charge, to any person obtaining a copy of |
39 |
| - * this software and associated documentation files (the "Software"), to deal in |
40 |
| - * the Software without restriction, including without limitation the rights to |
41 |
| - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of |
42 |
| - * the Software, and to permit persons to whom the Software is furnished to do so, |
43 |
| - * subject to the following conditions: |
| 27 | + * This program and the accompanying materials are made available under the |
| 28 | + * terms of the MIT License which is available at https://opensource.org/licenses/MIT. |
44 | 29 | *
|
45 |
| - * The above copyright notice and this permission notice shall be included in all |
46 |
| - * copies or substantial portions of the Software. |
47 |
| - * |
48 |
| - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
49 |
| - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
50 |
| - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR |
51 |
| - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
52 |
| - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
53 |
| - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 30 | + * SPDX-License-Identifier: MIT |
54 | 31 | */
|
55 | 32 |
|
56 |
| - |
57 | 33 | Eclipse Contributor Agreement
|
58 | 34 | ============
|
59 | 35 |
|
|
0 commit comments