If this is your first time contributing to an Eclipse Foundation project, you'll need to sign the Eclipse Contributor Agreement.
- Create an account on dev.eclipse.org
- Open your Account Settings tab, enter your GitHub ID and click Update Account
- Read and sign the ECA
- Your git commits must be signed off
- Use the exact same email address for your Eclipse account, your commit author, and your commit sign-off.
Search the issue tracker for a relevant issue or create a new one.
Fork the repository in GitHub and make changes in your fork, add a description of your changes, and submit a pull request.
Join the mailing list and email the community at sisu-dev@eclipse.org to discuss your ideas and get help.
The Sisu build requires Java 11 and Maven 3.6.3 (or above), while the resulting jars work with Java 8 and above.
Sisu follows the old Maven code style and code conventions. Since then, Maven switched to modern code style and code conventions that are not applicable to Sisu.
Avoid changing whitespace on lines that are unrelated to your pull request. This helps preserve the accuracy of the git blame view, and makes code reviews easier.
You can use the spotless maven plugin to automatically format code to the accepted code style
$ mvn spotless:apply- Mention the GitHub issue when relevant
- It's a good idea to follow the advice in Pro Git
- Sign-off your commits using
git commit --signofforgit commit -sfor short
Excessive branching and merging can make git history confusing. With that in mind
- Squash your commits down to a few commits, or one commit, before submitting a pull request
- Rebase your pull request changes on top of the current master. Pull requests shouldn't include merge commits.
Submit your pull request when ready. Two checks will be kicked off automatically
- IP Validation: checks that all committers signed the Eclipse CLA and signed their commits.
- The standard GitHub check that the pull request has no conflicts with the base branch.
One of the committers will take a look and provide feedback or merge your contribution.
That's it, thanks for contributing to Sisu!