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...
- 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).
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
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.
The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from https://www.eclipse.org/legal/dco/):
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Then you just add a line to every git commit message:
Signed-off-by: Joe Smith <[email protected]>
Use your real name (sorry, no pseudonyms or anonymous contributions.)
If you set your user.name and user.email git configs, you can sign your
commit automatically with git commit -s.