Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Codewind GitHub Workflows"
(Added in linking GitHub and Eclipse accounts information) |
(Sarah Ishida's changes (awaiting moderation)) |
||
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. | ||
+ | #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 youcan't find an open issue that's relevant, open a new issue. | |
− | * [https://github.com/eclipse/codewind-eclipse https://github.com/eclipse/codewind-eclipse] | + | == List of Codewind repositories == |
− | * [https://github.com/eclipse/codewind-vscode https://github.com/eclipse/codewind-vscode] | + | |
− | * [https://github.com/eclipse/codewind-docs https://github.com/eclipse/codewind-docs] | + | The following links point to repositories that are included in the Codewind project: |
+ | * Codewind Eclipse development plug-in: [https://github.com/eclipse/codewind-eclipse https://github.com/eclipse/codewind-eclipse] | ||
+ | * Codewind Visual Studio Code extension: [https://github.com/eclipse/codewind-vscode https://github.com/eclipse/codewind-vscode] | ||
+ | * Staging area for Codewind documentation: [https://github.com/eclipse/codewind-docs https://github.com/eclipse/codewind-docs] | ||
= Git or Gerrit? = | = 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. |
− | Refer to the following | + | |
− | + | = 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]. | ||
+ | |||
+ | 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: | |
− | Refer to the following | + | * [https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions#Overview Git contributions overview] |
− | * [https://wiki.eclipse.org/Development_Resources/Handling_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#Git Code | + | * [https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions#Multiple_Authors Git contributions with multiple authors] |
− | * [https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions#Multiple_Authors | + | |
− | + | 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 12:05, 10 June 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.
- 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 youcan'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:
- Codewind Eclipse development plug-in: https://github.com/eclipse/codewind-eclipse
- Codewind Visual Studio Code extension: https://github.com/eclipse/codewind-vscode
- Staging area for Codewind documentation: https://github.com/eclipse/codewind-docs
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:
- 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.
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:
- Git contributions overview
- Code Pull request review process in Git
- Git contributions with multiple authors
See Development Resources/Handling Git Contributions for full documentation on handling code contributing by committer.