Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 5.44 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 5.44 KB

Contributing to Eclipse PDE

Thanks for your interest in this project.

Project description

The Eclipse PDE™ (Plug-in Development Environment) provides tools to create, develop, test, debug, build and deploy Eclipse plug-ins, fragments, features, update sites and RCP products.

Developer resources

Information regarding source code management, builds, coding standards, and more.

The project issues and source code are maintained in GitHub

Be sure to search for existing issues before you create another one. Remember that contributions are always welcome!

Setting up GitHub account

Create an account at github.com using the same email id used for your Eclipse account. In case you, the contributor, already has an account, add the email to your account using https://github.com/settings/emails

Add the GitHub account id to the contributor's Eclipse account under the social media links section. If the contributor is already a committer in any of the projects, an email containing an invite to join that project's Github organization will be received within 2 hours. The contributor should accept the invite to maintain committer status in the GitHub organization

To create commits, it is recommended to add SSH public keys to your GitHub account. This can be done using https://github.com/settings/keys

Create an Eclipse Development Environment

Create Eclipse Development Environment for PDE

Recommended workflow

The recommended way of developing code is inside a fork of the main repository (see Fork and pull model in the GitHub documentation).

Here are the steps:

  1. Use the fork button available on the GitHub repository page to create a forked repository under your GitHub account.
  2. If a fork already exists, click on "Sync fork" to get the latest source code.
  3. Clone the forked repository to the Eclipse workspace. The repository link can be found by clicking the Code button on the top right in the "<> Code" tab
  4. Create a local branch
  5. Develop fix
  6. Commit code changes to a local branch. Make multiple commits if necessary as history can be retained. Note: Before committing changes, if you are a non-committer, refer to the Eclipse Contributor Agreement in the following section
  7. Once the fix is ready, push the branch to origin (in this case, the forked repository)
  8. Open the forked repository page and switch to the branch where the fix is developed. A new option should appear just below the code button "Contribute". Click on this to open "Pull Request", which is also referred to as PR.
  9. Verify the branch information (e.g. whether you are contributing to master or any other branch, list of commits). If everything is OK, please click on the "Create pull request" button at the bottom right
  10. If necessary, you can add reviewers.
  11. Any commits pushed to the devlopment branch (used to create PR) automatically gets added to the opened PR.
  12. A reviewer can review the PR on the GitHub portal itself or fetch the PR using egit menu "Fetch github PR"
  13. All PRs will get verified for ECA and PR validations (same as gerrit validation)
  14. Once the PR is approved there are two options to merge. You can select either of these based on the requirement; the following are recommendations only. Select an option based on the requirement
  • Rebase and Merge (retains commit history from PR, which is useful in developing a feature)
  • Squash and Merge (all commits in PR gets squashed into a single commit, which is useful in bug fixes)
  1. Once the PR gets merged, the development branch used for the PR can be deleted.

Commit message recommendations

<issue title> #<issue number>

Example: The eclipse-test-framework deliverable contains unsigned bundles #32

Again, this is a recommendation on the issue title part. Instead of an issue title, if needed, provide a concise description of changes. Please do not forget to add the issue number to the commit message. This is used to link with the GitHub issue.

Eclipse Contributor Agreement

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

Setting up development environment

See https://wiki.eclipse.org/Platform/How_to_Contribute

Contact

Contact the project developers via the project's "dev" list.