Skip to content

Commit c37a482

Browse files
committed
contributing: update project contribution guides
Signed-off-by: Mihai Tudor Panu <[email protected]>
1 parent ab25e56 commit c37a482

File tree

2 files changed

+55
-35
lines changed

2 files changed

+55
-35
lines changed

CONTRIBUTING

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing to Eclipse UPM
2+
3+
Thanks for your interest in this project.
4+
5+
## Project description
6+
7+
The Eclipse UPM repository provides software drivers for a wide variety of
8+
commonly used sensors and actuators. These software drivers interact with the
9+
underlying hardware platform (or microcontroller), as well as with the attached
10+
sensors, through calls to Eclipse MRAA APIs.
11+
12+
* https://projects.eclipse.org/projects/iot.upm
13+
14+
## Developer resources
15+
16+
Information regarding source code management, builds, coding standards, and
17+
more.
18+
19+
* https://projects.eclipse.org/projects/iot.upm/developer
20+
21+
The project maintains the following source code repositories
22+
23+
24+
## Eclipse Contributor Agreement
25+
26+
Before your contribution can be accepted by the project team contributors must
27+
electronically sign the Eclipse Contributor Agreement (ECA).
28+
29+
* http://www.eclipse.org/legal/ECA.php
30+
31+
Commits that are provided by non-committers must have a Signed-off-by field in
32+
the footer indicating that the author is aware of the terms by which the
33+
contribution has been provided to the project. The non-committer must
34+
additionally have an Eclipse Foundation account and must have a signed Eclipse
35+
Contributor Agreement (ECA) on file.
36+
37+
For more information, please see the Eclipse Committer Handbook:
38+
https://www.eclipse.org/projects/handbook/#resources-commit
39+
40+
## Contact
41+
42+
Contact the project developers via the project's "dev" list.
43+
44+
*

docs/contributions.md

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,35 @@
11
Contributing a module {#contributions}
22
=====================
33

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:
145
- The top of each source file must contain a comment block containing the
156
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.
2011
- Attempt to have some decent API documentation as described in the the @ref
2112
documentation [guide](documentation.md).
2213

2314
Including the MIT license
2415
=========================
2516
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
2718
file:
2819

2920
/*
30-
* The MIT License (MIT)
31-
*
32-
* Author: <your full name>
21+
* Author: <your full name>
3322
* Copyright (c) <year> <copyright holder>
3423
*
35-
* Author: <contributing author full name - if applicable>
24+
* Author: <contributing author full name - if applicable>
3625
* Copyright (c) <year> <copyright holder>
3726
*
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.
4429
*
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
5431
*/
5532

56-
5733
Eclipse Contributor Agreement
5834
============
5935

0 commit comments

Comments
 (0)