Skip to content
Snippets Groups Projects
CONTRIBUTING.md 2.64 KiB
Newer Older
# Contributing to Eclipse 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 openPASS. 
## Eclipse openPASS  
Eclipse 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. 

## Developer resources

  * [Working Group Website](https://openpass.eclipse.org/)
  * [Developer Website](https://projects.eclipse.org/projects/automotive.openpass)
  * Mailing list: Join our [developer list](https://accounts.eclipse.org/mailing-list/openpass-dev)
  * Bugs can be reported in [GitLab](https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues) by anybody who owns an Eclipse account. Please use type “Incident”
  * [Documentation](https://openpass.eclipse.org/resources/#documentation)
Dmitri Fix's avatar
Dmitri Fix committed
## Eclipse Contributor / Committer Agreement
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/.
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.

* openpass-dev@eclipse.org

## How to contribute

Tuan Duong Quang's avatar
Tuan Duong Quang committed
The openPASS source code can be found [here](https://gitlab.eclipse.org/eclipse/openpass/opSimulation).
To build the project, follow the guide in "pathToRepo\sim\doc\OSI World Setup Guide.pdf".

The branch 'develop' contains the contributions that will be included in the next release. The 'main' branch contains the latest stable release.
### Committer contribution process

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 'develop'.
4.  (you) Work on it and respect the following points:
    - Stick to the [coding guideline](doc/source/developer_information/30_coding_conventions.rst)
    - Amend the documentation if necessary
    - Provide unit-tests in googletest format
    - Make sure, the code base with your contribution compiles
5.	(you) Assign the issue to another committer.
6.	(other committer) Review the code.
7.	(other committer) To merge new branch into 'develop' you can close the merge request via GitLab.
8.	(you) Present your contribution to the openPASS WG