mirror of
https://github.com/eclipse/upm.git
synced 2025-11-05 01:24:54 +03:00
docs: refresh README and contribution docs
Signed-off-by: Alex T <alext.mkrs@gmail.com>
This commit is contained in:
44
CONTRIBUTING
44
CONTRIBUTING
@@ -1,44 +0,0 @@
|
|||||||
# 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.
|
|
||||||
|
|
||||||
*
|
|
||||||
14
README.md
14
README.md
@@ -29,8 +29,8 @@ iWater.
|
|||||||
```
|
```
|
||||||
The developer community is invited to propose new interfaces for actuator types.
|
The developer community is invited to propose new interfaces for actuator types.
|
||||||
|
|
||||||
The UPM project is joining the Eclipse Foundation as an Eclipse IoT project.
|
The UPM project is an Eclipse Foundation IoT project.
|
||||||
You can read more about this [here](https://projects.eclipse.org/proposals/eclipse-upm).
|
You can read more about this [here](https://projects.eclipse.org/projects/iot.upm).
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
@@ -63,7 +63,7 @@ A sensor/actuator is expected to work as such (here is the MMA7660 accelerometer
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Browse through the list of all [examples](https://github.com/eclipse/upm/tree/master/examples).
|
Browse through the list of all [examples](/examples/).
|
||||||
|
|
||||||
Multi-sensor samples for starter and specialized kits can be found in the
|
Multi-sensor samples for starter and specialized kits can be found in the
|
||||||
[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
|
[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
|
||||||
@@ -77,7 +77,6 @@ Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) fro
|
|||||||
The UPM project includes support for multiple industrial-grade sensors, actuators, radios,
|
The UPM project includes support for multiple industrial-grade sensors, actuators, radios,
|
||||||
protocols and standards in use today. It is also highly integrated with the Eclipse IDE
|
protocols and standards in use today. It is also highly integrated with the Eclipse IDE
|
||||||
through the help of the Foundation's partners.
|
through the help of the Foundation's partners.
|
||||||
Learn more about [tools](https://software.intel.com/en-us/tools-by-segment/systems-iot).
|
|
||||||
|
|
||||||
### Installing UPM
|
### Installing UPM
|
||||||
|
|
||||||
@@ -87,9 +86,6 @@ Find notes on how to install UPM on various OS'es on this [page](docs/installing
|
|||||||
|
|
||||||
See building documentation [here](docs/building.md).
|
See building documentation [here](docs/building.md).
|
||||||
|
|
||||||
[](https://travis-ci.org/intel-iot-devkit/upm)
|
|
||||||
[](https://sonarcloud.io/dashboard?id=upm-master)
|
|
||||||
|
|
||||||
### Guidelines and rules for new UPM contributions
|
### Guidelines and rules for new UPM contributions
|
||||||
|
|
||||||
Before you begin development, take a look at our naming [conventions](docs/naming.md).
|
Before you begin development, take a look at our naming [conventions](docs/naming.md).
|
||||||
@@ -99,8 +95,8 @@ Next, review the project's [contribution guide](docs/contributions.md).
|
|||||||
|
|
||||||
Make sure you add yourself as an author on every new code file submitted.
|
Make sure you add yourself as an author on every new code file submitted.
|
||||||
If you are providing a fix with significant changes, feel free to add yourself
|
If you are providing a fix with significant changes, feel free to add yourself
|
||||||
as a contributor. Signing-off your commits and accepting the ECA is mandatory
|
as a contributor. Accepting the ECA is mandatory for making new contributions
|
||||||
for making new contributions to this project.
|
to this project.
|
||||||
|
|
||||||
Documenting your code is also a big part of the task. We have a strict set of
|
Documenting your code is also a big part of the task. We have a strict set of
|
||||||
tags used to classify our sensors and their capabilities. You can find out more
|
tags used to classify our sensors and their capabilities. You can find out more
|
||||||
|
|||||||
@@ -33,21 +33,20 @@ file:
|
|||||||
Eclipse Contributor Agreement
|
Eclipse Contributor Agreement
|
||||||
============
|
============
|
||||||
|
|
||||||
Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](http://www.eclipse.org/legal/ECA.php) in place.
|
Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](https://www.eclipse.org/legal/eca/) in place.
|
||||||
|
|
||||||
Here is the checklist for contributions to be considered _acceptable_:
|
Here is the checklist for contributions to be considered _acceptable_:
|
||||||
|
|
||||||
1. [Create an account at Eclipse](https://dev.eclipse.org/site_login/createaccount.php).
|
1. [Create an account at Eclipse](https://accounts.eclipse.org/user/register).
|
||||||
2. Add your GitHub user name in your account settings.
|
2. Add your GitHub user name in your account settings.
|
||||||
3. [Log into the project's portal](https://projects.eclipse.org/) and sign the ["Eclipse ECA"](https://projects.eclipse.org/user/sign/cla).
|
3. [Log in to the projects forge](https://www.eclipse.org/contribute/cla/) and sign the ["Eclipse ECA"](https://accounts.eclipse.org/user/eca).
|
||||||
4. Ensure that you [_sign-off_](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Signing_off_on_a_commit) your Git commits.
|
|
||||||
5. Ensure that you use the _same_ email address as your Eclipse account in commits.
|
5. Ensure that you use the _same_ email address as your Eclipse account in commits.
|
||||||
6. Include the appropriate copyright notice and license at the top of each file.
|
6. Include the appropriate copyright notice and license at the top of each file.
|
||||||
|
|
||||||
Your signing of the ECA will be verified by a webservice called 'ip-validation'
|
Your signing of the ECA will be verified by a Github Check called 'eclipsefdn/eca'
|
||||||
that checks the email address that signed-off on your commits has signed the
|
that checks the email address that authored your commits has signed the
|
||||||
ECA. **Note**: This service is case-sensitive, so ensure the email that signed
|
ECA. **Note**: This service is case-sensitive, so ensure the email that signed
|
||||||
the ECA and that signed-off on your commits is the same, down to the case.
|
the ECA and that authored your commits is the same, down to the case.
|
||||||
|
|
||||||
Creating a new sensor library using the sensortemplate
|
Creating a new sensor library using the sensortemplate
|
||||||
=======================================
|
=======================================
|
||||||
|
|||||||
Reference in New Issue
Block a user