CONTRIBUTING.md 2.67 KB
Newer Older
Arun Das's avatar
Arun Das committed
1
2
3
4
5
# Contributing to Eclipse sim@openpass

This guide provides all necessary information to enable [contributors and committers](https://www.eclipse.org/projects/dev_process/#2_3_1_Contributors_and_Committers) to contribute to Eclipse sim@openPASS. 

## Eclipse sim@openPASS  
6
Eclipse sim@openPASS provides a software platform that enables the simulation of traffic scenarios to predict the real-world effectiveness of advanced driver assistance systems or automated driving functions. 
Arun Das's avatar
Arun Das committed
7
8
9

## Developer resources

10
11
  * [Working Group Website](https://openpass.eclipse.org/)
  * [Developer Website](https://projects.eclipse.org/projects/automotive.simopenpass)
Arun Das's avatar
Arun Das committed
12
  * Mailing list: Join our [developer list](https://accounts.eclipse.org/mailing-list/simopenpass-dev)
13
14
  * Bugs can be reported in [GitLab](https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass/-/issues) by anybody who owns an Eclipse account. Please use type “Incident”
  * [Documentation](https://openpass.eclipse.org/resources/#documentation)
Arun Das's avatar
Arun Das committed
15

Dmitri Fix's avatar
Dmitri Fix committed
16
## Eclipse Contributor / Committer Agreement
Arun Das's avatar
Arun Das committed
17

18
Before your contribution can be accepted by the project team, contributors and committers must sign the correct agreement depending on their status. Please read on how to proceed on: https://www.eclipse.org/legal/committer_process/re-sign/.
Arun Das's avatar
Arun Das committed
19

20
For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit.
Arun Das's avatar
Arun Das committed
21
22
23
24
25
26
27
28
29

## Contact

Contact the project developers via the project's "dev" list.

* simopenpass-dev@eclipse.org

## How to contribute

Arun Das's avatar
Arun Das committed
30
The sim@openpass source code can be found [here](https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass).
Arun Das's avatar
Arun Das committed
31
32
33

To build the project, follow the guide in "pathToRepo\sim\doc\OSI World Setup Guide.pdf".

34
The branch 'servant' contains the contributions that will be included in the next release. The 'main' branch contains the latest stable release.
Arun Das's avatar
Arun Das committed
35
36
37

### Committer contribution process

Dmitri Fix's avatar
Dmitri Fix committed
38
39
40
41
42
43
44
1.  (you) Discuss your planned contribution with the project lead first.
2.  (you) If needed, create the Issue on GitLab and assign it to yourself.
3.  (you) In GitLab, create a merge request. The related branch will be created from the branch 'servant'.
4.  (you) Work on it and respect the following points:
    - Stick to the [coding guideline](https://wiki.eclipse.org/images/3/3f/OpenPASS_Conventions.pdf)
    - Amend the documentation if necessary
    - Provide unit-tests in googletest format
45
    - Make sure, the code base with your contribution compiles
46
47
48
49
5.	(you) Assign the issue to another committer.
6.	(other committer) Review the code.
7.	(other committer) To merge new branch into 'servant' you can close the merge request via GitLab.
8.	(you) Present your contribution to the openPASS WG