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.
Difference between revisions of "Codewind GitHub Workflows"
(→Current list of Codewind repositories) |
(→Making a pull request) |
||
| (22 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Follow these instructions to make contributions to [https://projects.eclipse.org/projects/ecd.codewind Eclipse Codewind]. | |
| − | = | + | = Signing the ECA = |
| − | + | Before you can contribute to any Eclipse project, you need to sign the [https://www.eclipse.org/legal/ECA.php Eclipse Contributor Agreement (ECA)]. | |
| − | + | #To verify that you signed the ECA, sign in to [https://accounts.eclipse.org/ your Eclipse account]. | |
| + | #View your '''Status''' and make sure that a check mark appears with the '''Eclipse Contributor Agreement'''. | ||
| + | #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. | ||
| + | #Fill out the form and click the '''Accept''' button. | ||
| − | + | = Associating your Eclipse profile with your GitHub ID = | |
| − | + | #From [https://accounts.eclipse.org/ your Eclipse account], select '''Edit Profile'''. | |
| + | #On the '''Personal Information''' tab, go to the '''Social Media Links''' section and add your GitHub user name to the '''GitHub Username''' field. | ||
| + | #Answer the '''Have you changed employers''' question | ||
| + | #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: | ||
| + | * The main Codewind repository: [https://github.com/eclipse/codewind https://github.com/eclipse/codewind] | ||
| + | * Installer: [https://github.com/eclipse/codewind-installer https://github.com/eclipse/codewind-installer] | ||
| + | * Codewind Eclipse development plug-in: [https://github.com/eclipse/codewind-eclipse https://github.com/eclipse/codewind-eclipse] | ||
| + | * OpenAPI implementation for Codewind Eclipse development: [https://github.com/eclipse/codewind-openapi-eclipse https://github.com/eclipse/codewind-openapi-eclipse] | ||
| + | * Codewind Visual Studio Code extension: [https://github.com/eclipse/codewind-vscode https://github.com/eclipse/codewind-vscode] | ||
| + | * OpenAPI implementation for Codewind Visual Studio Code development: [https://github.com/eclipse/codewind-openapi-vscode https://github.com/eclipse/codewind-openapi-vscode] | ||
| + | * File Watcher: [https://github.com/eclipse/codewind-filewatchers https://github.com/eclipse/codewind-filewatchers] | ||
| + | * Staging area for Codewind documentation: [https://github.com/eclipse/codewind-docs https://github.com/eclipse/codewind-docs] | ||
| + | * Codewind Eclipse Che plugin: [https://github.com/eclipse/codewind-che-plugin https://github.com/eclipse/codewind-che-plugin] | ||
| + | * Profiler for Node: [https://github.com/eclipse/codewind-node-profiler https://github.com/eclipse/codewind-node-profiler] | ||
| + | * Profiler for Java: [https://github.com/eclipse/codewind-java-profiler https://github.com/eclipse/codewind-java-profiler] | ||
| + | |||
| + | = 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. | ||
| + | |||
| + | = Setup Git Environment = | ||
| + | |||
| + | Follow this doc to setup your Codewind Git repository before submitting a pull request: | ||
| + | [https://wiki.eclipse.org/Codewind_Git_Repo_Setup Setup Git Environment for Codewind Development] | ||
| + | |||
| + | = Making a pull request = | ||
| + | |||
| + | Refer to the following instructions that are relevant to Codewind: | ||
| + | #Before submitting a pull request, complete the [https://wiki.eclipse.org/Codewind_GitHub_Workflows#Signing_the_ECA Signing the ECA] instructions. | ||
| + | #Issue a standard GitHub pull request. | ||
| + | #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 [https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#The_Commit_Record The Commit Record]. Both VS Code and Eclipse have options for automatically signing-off commits. | ||
| + | |||
| + | See [https://wiki.eclipse.org/Development_Resources/Contributing_via_Git 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 | ||
| + | * [https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions#Overview Git contributions overview] | ||
| + | * [https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions#Git Code Pull request review process in Git] | ||
| + | * [https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions#Multiple_Authors Git contributions with multiple authors] | ||
| + | * When merging, it is recommended to use "Rebase and Merge" option instead of the default merge option | ||
| + | |||
| + | See [https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#via_GitHub Development Resources/Handling Git Contributions] for full documentation on handling code contributing by committer. | ||
Revision as of 13:38, 25 July 2019
Follow these instructions to make contributions to Eclipse Codewind.
Contents
Signing the ECA
Before you can contribute to any Eclipse project, you need to sign the Eclipse Contributor Agreement (ECA).
- To verify that you signed the ECA, sign in to your Eclipse account.
- View your Status and make sure that a check mark appears with the Eclipse Contributor Agreement.
- 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.
- Fill out the form and click the Accept button.
Associating your Eclipse profile with your GitHub ID
- From your Eclipse account, select Edit Profile.
- On the Personal Information tab, go to the Social Media Links section and add your GitHub user name to the GitHub Username field.
- Answer the Have you changed employers question
- 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:
- The main Codewind repository: https://github.com/eclipse/codewind
- Installer: https://github.com/eclipse/codewind-installer
- Codewind Eclipse development plug-in: https://github.com/eclipse/codewind-eclipse
- OpenAPI implementation for Codewind Eclipse development: https://github.com/eclipse/codewind-openapi-eclipse
- 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
- Profiler for Node: https://github.com/eclipse/codewind-node-profiler
- Profiler for Java: https://github.com/eclipse/codewind-java-profiler
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.
Setup Git Environment
Follow this doc to setup your Codewind Git repository before submitting a pull request: Setup Git Environment for Codewind Development
Making a pull request
Refer to the following instructions that are relevant to Codewind:
- Before submitting a pull request, complete the Signing the ECA instructions.
- Issue a standard GitHub pull request.
- 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. Both VS Code and Eclipse have options for automatically signing-off commits.
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, it is recommended to 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.