Before considering contributing you should be familiar with Eclipse OpenBSW project.
- You should have Set Up a Working Environment in which you can build and test.
- You should be familiar with the Guidelines and the Code of Conduct.
- Contributions should pass all automated builds and tests, including Building the Documentation.
The primary communication channel for contributions is through issues. If you have found a bug or would like a new feature, you should first check if it has already been raised there. Please add all information you can share and that will help to reproduce bugs. For new features, use case scenario help understand the motivation behind it.
The mailing list openbsw-dev hosts developer discussions. Please check if the question has been asked before.
Before you get started investing significant time in something you want to get merged and maintained, you should talk with the team through an issue. Simply choose the issue you would want to work on, and tell everyone that you are willing to do so and how you would approach it. The team will be happy to guide you and give feedback.
To contribute your work you need to:
- Fork the Eclipse OpenBSW project
- Create your Branch (
git checkout -b newBranchName) - Commit your Changes (
git commit -m 'Add some feature/fix some bug') - Push to the Branch (
git push origin newBranchName) - Open a Pull Request
Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA).
For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit
To complete and submit a ECA, log into the Eclipse projects forge (you will need to create an account with the Eclipse Foundation if you have not already done so). Click on "Eclipse Contributor Agreement" and complete the form. Be sure to use the same email address when you register for the account that you intend to use when you commit to Git.