Revision as of 15:29, 18 June 2019

Follow these instructions to make contributions to Eclipse Codewind.

Signing the ECA

Before you can contribute to any Eclipse project, you need to sign the Eclipse Contributor Agreement (ECA).

1. To verify that you signed the ECA, sign in to your Eclipse account.
2. View your Status and make sure that a check mark appears with the Eclipse Contributor Agreement.
3. If the check mark does not appear, click the Eclipse Contributor Agreement in the Status box to go to the agreement that you need to sign.
4. Fill out the form and click the Accept button.

Associating your Eclipse profile with your GitHub ID

1. From your Eclipse account, select Edit Profile.
2. On the Personal Information tab, go to the Social Media Links section and add your GitHub user name to the GitHub Username field.
3. Answer the Have you changed employers question
4. Enter your Eclipse password in the Current password field and then click Save.

Creating or finding an issue

Codewind uses GitHub for issues and source control. To make a contribution, locate an issue that is currently open and relevant to your contribution. If you can't find an open issue that's relevant, open a new issue.

List of Codewind repositories

The following links point to repositories that are included in the Codewind project:

• Installer: https://github.com/eclipse/codewind-installer
• Codewind Eclipse development plug-in: https://github.com/eclipse/codewind-eclipse
• OpenAPI implementation for Codewind Eclipse development: [1]
• Codewind Visual Studio Code extension: https://github.com/eclipse/codewind-vscode
• OpenAPI implementation for Codewind Visual Studio Code development: https://github.com/eclipse/codewind-openapi-vscode
• File Watcher: https://github.com/eclipse/codewind-filewatchers
• Staging area for Codewind documentation: https://github.com/eclipse/codewind-docs
• Codewind Eclipse Che plugin: https://github.com/eclipse/codewind-che-plugin

Git or Gerrit?

The Codewind project uses Git instead of Gerrit for the code review process. Most of the Eclipse development documentation related to code review has instructions related to both Git and Gerrit. Refer to the Git section for the Codewind project.

Making a pull request

Refer to the following instructions that are relevant to Codewind:

1. Before submitting a pull request, complete the Signing the ECA instructions.
2. Issue a standard GitHub pull request.
3. Ensure that you have an ECA and that you add a sign-off statement to the commit record before you issue the request. For more information, see The Commit Record.

See Development Resources/Contributing via Git for full documentation on contributing code.

The committer reviews and accepts the request

Refer to the following instructions that are relevant to Codewind:

• If the PR is done by a non-committer, assign the PR to the author of the PR for tracking purpose
• Git contributions overview
• Code Pull request review process in Git
• Git contributions with multiple authors
• When merging, use "Rebase and Merge" option instead of the default merge option

See Development Resources/Handling Git Contributions for full documentation on handling code contributing by committer.