Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Codewind GitHub Workflows
This page is a guide to making contributions to Eclipse Codewind
Contents
Sign the ECA
The first step to contributing to any Eclipse project is to sign the Eclipse Contributor Agreement. To verify that this has been done, go to your Eclipse account (you will need to sign in, if you have not already done so), and look at the Status box on the right hand side. There should be a checkmark next to Eclipse Contributor Agreement. If there is not, please click on Eclipse Contributor Agreement in that box, and it will take you to the agreement that you need to sign. Fill out that form and press the Accept button at the bottom.
Create/find an issue
Codewind uses GitHub for issues and source control. In order to make a contribution, you will need to either locate a currently open (and relevant) issue for your contribution, or else open an issue.
Current list of Codewind repositories
- https://github.com/eclipse/codewind-eclipse - Codewind's Eclipse development plugin
- https://github.com/eclipse/codewind-vscode Codewind's Visual Studio Code extension
- https://github.com/eclipse/codewind-docs - staging area for Codewind documentation
Git or Gerrit?
Codewind project uses Git instead of Gerrit for code review process. Most of the Eclipse development documentation related to code review have instructions related to both Git and Gerrit. Please refer to the Git specific section for Codewind project.
Make a pull request
Refer to the following specific instructions that are most relevant to Codewind:
- Before submitting any pull request, make sure you have followed the Sign the ECA instruction above
- You can issue a standard GitHub pull request.
- Ensure that you have a ECA and that the commit record is properly "Signed-off-by" before you issue the request. Details can be found in signed off with the commit record
Refer to Development Resources/Contributing via Git for full documentation on contributing code.
Committer reviews/accepts the request
Refer to the following specific instructions that are most relevant to Codewind:
Refer to Development Resources/Handling Git Contributions for full documentation on handling code contributing by committer.