CONTRIBUTING.md



After you've reviewed these contribution guidelines, you'll be all set to
contribute to this project.


Contributing to Eclipse sim@openpass
This guide provides all necessary information to enable contributors and committers to contribute to Eclipse sim@openPASS.

Eclipse sim@openPASS
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.

Developer resources

Working Group Website
Developer Website
Mailing list: Join our developer list

Bugs can be reported in GitLab by anybody who owns an Eclipse account. Please use type “Incident”
Documentation


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.

simopenpass-dev@eclipse.org


How to contribute
The sim@openpass source code can be found here.
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

(you) Discuss your planned contribution with the project lead first.
(you) If needed, create the Issue on GitLab and assign it to yourself.
(you) In GitLab, create a merge request. The related branch will be created from the branch 'develop'.
(you) Work on it and respect the following points:

Stick to the coding guideline

Amend the documentation if necessary
Provide unit-tests in googletest format
Make sure, the code base with your contribution compiles


(you) Assign the issue to another committer.
(other committer) Review the code.
(other committer) To merge new branch into 'develop' you can close the merge request via GitLab.
(you) Present your contribution to the openPASS WG