1.1 Install Git

Windows

Download Git for Windows, run the installer, and keep the recommended options.

macOS

Open Terminal and run:

xcode-select --install

Alternatively, visit git-scm.com.

Linux

Install Git with your distribution’s package manager, for example:

sudo apt install git

Alternatively, visit git-scm.com.

1.2 Check Git

Open a new terminal window and run:

git --version

You should see a version number, for example git version 2.47.1.windows.1.

If the command is not found, close and reopen the terminal. On Windows, you may try Git Bash rather than Command Prompt.

1.3 Tell Git who you are

Git records an author name and email address with every commit.

Run these commands once (replacing the placeholders):

git config --global user.name "Your Name"
git config --global user.email "you@example.com"

Check the saved values:

git config --global --get user.name
git config --global --get user.email

Use an email address verified in GitHub (later on) if you want GitHub to link your commits to your profile. You can change that at any point.

2.1 Set up GitHub

GitHub will hold the shared online copy of the project.

  1. Visit github.com and create an account, or sign in.
  2. Use a private email address as your primary address so the account remains yours after you leave an organization.
  3. Add and verify your university email for student benefits and commit attribution.
  4. Enable two-factor authentication when GitHub offers it.

Student benefit: After creating your GitHub account, apply for GitHub Education. Verified students can activate GitHub Copilot Student for free.

Optional: 2.2 Create an SSH key

SSH is a secure way for Git on your computer to communicate with GitHub. Your private key stays on this computer, while GitHub uses the matching public key to recognize you when you push or pull. This avoids sending your password.

On Windows, open Git Bash for the commands below. First, check whether this computer already has an Ed25519 public key:

ls ~/.ssh/id_ed25519.pub

If the file exists, keep it and display it with the final command below. Otherwise, create a key:

ssh-keygen -t ed25519 -C "you@example.com"
cat ~/.ssh/id_ed25519.pub

Using Command Prompt instead? Replace ls with dir %USERPROFILE%\.ssh\id_ed25519.pub and cat with type %USERPROFILE%\.ssh\id_ed25519.pub. Press Enter to accept the proposed key location.

SSH is optional. GitHub also works through HTTPS, browser sign-in, and Git Credential Manager. SSH is convenient because the key identifies this computer after a one-time setup. SSH repository addresses begin with git@github.com, while HTTPS addresses begin with https://github.com.

Optional: 2.3 Add SSH key

Adding the public key connects the key on this computer to your GitHub account.

On GitHub, open:

Profile picture → Settings → SSH and GPG keys → New SSH key

Give the key a descriptive title, such as My laptop. Paste the public key and save it.

Copy only the file ending in .pub. Never share the private key named id_ed25519.

Optional: 2.4 Test the connection

One connection test confirms that GitHub recognizes your SSH key.

Back in the terminal, run:

ssh -T git@github.com

The first time, type yes to confirm GitHub’s host fingerprint. A successful message names your GitHub account and notes that GitHub does not provide shell access.

3. Final check

You are ready when these work

git --version
git config --global --get user.name
ssh -T git@github.com

Return to the workshop once Git is installed, your author identity is set(, and GitHub recognizes your SSH key)