Getting started with GitHub and Codewind

New to GitHub and contributing to Codewind? No worries! Get started here to start contributing to Eclipse repos, create a pull request, and more.

Setting up your Eclipse account

1. Create an Eclipse account. Verify your account after you receive the verification email.
2. Sign the Eclipse Contributor Agreement (ECA).
3. Associate your Eclipse profile with your GitHub ID. For more information on how to set up your Eclipse account, see the Codewind GitHub Workflows wiki at https://wiki.eclipse.org/Codewind_GitHub_Workflows.

Creating a pull request

Prerequisites

1. Select your editor.
   • A. Use Eclipse, VS Code, the command line, or a combination of these tools to create a pull request. Unless you're an Eclipse committer, your commit needs to include a signoff statement, which you can't add with GitHub Desktop or the GitHub web browser.
   • B. These instructions show how to use the command line to work with GitHub and VS Code to edit a file.
2. If you don't already have access to Git commands with your Terminal, set it up by completing these instructions: https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line.
3. Clone the repo that contains the files you want to edit.
   • Go to the Code tab of the repo and click Clone or download.
   • Copy the text in the Clone with SSH text box.
     • If you currently don't have any SSH keys on your machine and associated with your GitHub account, go to the "Adding an SSH key" section.
   • Go back to your command line and go the folder in which you want to clone the repo.