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
- Use the exact same email address for your Eclipse account and your commit author.
Search the issue tracker for a relevant issue or create a new one. Comment on the issue expressing your interest to work on it. One of the project maintainers will assign the issue to you.
- Fork the repository in GitHub and make changes in your fork.
- Submit a pull request.
Details on working with GitHub for Eclipse Collections is located at the Eclipse Collections Wiki.
Join the mailing list and email the community at [email protected] to discuss your ideas and get help.
Eclipse Collections Kata follows a coding style that is similar to Google's Style Guide for Java, but with curly braces on their own lines.
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.
- Use the imperative mood as in "Fix bug" or "Add feature" rather than "Fixed bug" or "Added feature"
- Mention the GitHub issue when relevant
- It's a good idea to follow the advice in Pro Git
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. Three checks will be kicked off automatically.
- IP Validation: Checks that all committers signed the Eclipse CLA and signed their commits.
- Continuous integration: GitHub Actions that run JUnit tests.
- The standard GitHub check that the pull request has no conflicts with the base branch.
Make sure all the checks pass. One of the committers will take a look and provide feedback or merge your contribution.
That's it! Thanks for contributing to the Eclipse Collections Kata!