Authors: Eric Udlis, Ben Everson, Noah Kurszewski, James Vollmer
This tutorial is to provide instructions on the installation and setup of Git and GitHub and to introduce the basics of Git version control, as well as how to GitHub.
This Tutorial is based on the one from hubspot
WSL and Ubuntu Installation and Setup (Fellow Windows People Start Here if You Want a Good Time)
This portion of the tutorial is to guide new Firmware members in the installation of WSL. Requirements for this tutorial are that you are using your **personal laptop** that runs **Windows 10, Windows 11, or Linux**. Windows users, please complete WSL installation before continuing with the GitHub tutorial. If you use Linux, then you can skip ahead to the GitHub portion.I have found that Windows Terminal works best for WSL, as it combines PowerShell and your WSL distribution into one terminal. If your laptop doesn't already have it installed, you can download it here.
After it installs, open Windows terminal as an administrator by right clicking on the Terminal icon, then clicking "Run as adminstrator." Your terminal will likely initially open to Command Prompt or PowerShell. If it doesn't open to PowerShell, click the dropdown arrow to the right of the plus button and select Windows PowerShell.
Once running PowerShell as an admin, type wsl --install in the terminal and hit enter. If all goes to plan, WSL will begin installing Ubuntu, and the terminal window will begin outputing its progress. Once the installation finishes, the terminal will tell you that a restart is required. Restart your computer now, then return to the tutorial.
Once you're back, open Terminal as an admin again, open PowerShell and run the following command: wsl --set-default-version 2. This sets your WSL to the correct version for our use.
After the restart, an Ubuntu window should open automatically and display the progress of the last of the Ubuntu installation. If it didn't open, use the Start menu or the Windows search bar to search for Ubuntu. It will appear as a Windows application, so open it up like you would any other app. After the installation finishes, you will be asked to enter in a username and password for your distribution. You can choose whatever you'd like for these, but an important thing to note is that you will not be able to see your password as you type. This is a security feature called blind typing, and is completely normaL.
As you likely noticed, the Ubuntu window did not open in Windows Terminal. Once you've set your login, close out the window and pull up Windows Terminal. To get to Ubuntu in Terminal, click the dropdown arrow to the right of the plus button, then click on Ubuntu.
Now in the Ubuntu terminal, type cd ~ to ensure you're in your root directory. Next, run sudo apt update && sudo apt upgrade to ensure all of your packages are up to date.
Open Ubuntu in Windows Terminal by clicking the dropdown arrow to the right of the plus button, then click on Ubuntu. Once in the linux terminal, run the following command to ensure git is installed.
sudo apt install git
Download git here. Follow the walkthrough, all default options should be good. Don't touch them unless you know what you're doing.
- Follow the instructions in the “Generating a new SSH key” section of Generating a new SSH key. It isn’t necessary to add your SSH key to the ssh-agent.
- Follow the instructions on Adding the SSH key to your GitHub account.
- When you copy your SSH key to GitHub, it should have your email at the end of it. E.g.
ssh-ed25519 <bunch_of_junk> [email protected]
- When you copy your SSH key to GitHub, it should have your email at the end of it. E.g.
Bucky@BSR~$: git config --global user.name "<Your name>" // Sets the name Git associates with you
Bucky@BSR~$: git config --global user.email "<The email that you used to set up your GitHub account>" // Sets the email Git associates with you
Bucky@BSR~$: git config --global --list // Lists your Git profile information
[email protected]
user.name=Bucky Badger
... Maybe some other stuff if you've added other info, like if you're cool
core.editor=vim // vim is the superior text editor
No matter what project you're working on in Badger Solar Racing, you will always be working in a repository (Repo for short). To use git we'll be using the terminal. Check out some tutorials on the wiki. In this guide you will need to know the following.
Bucky@BSR~$: ls // Lists the files and directories in your current directory
Bucky@BSR~$: cd // Navigates to directory use `cd ..` to navigate up a directory
Bucky@BSR~$: pwd // Prints your working directory
We already have code up on GitHub so the first step is to "clone" a copy of what we have on your local machine. To begin, open up a terminal (on windows use Git Bash or WSL to follow the commands used in this tutorial) and navigate to where you'd like your project to be located. If you have a "projects" folder, this would be the place. This command will navigate you to your home directory
Bucky@BSR~$: cd ~
Next grab the clone link from the GitHub Page. You will need to navigate to the actual webpage of the git repository on GitHub. You can find a list of all Badger Solar Racing Repos by clicking here. If you're reading this on the GitHub page, just click the green button in the upper right that says "Code." This opens a dropdown window. In that window, click "SSH" if it isn't already selected, then copy the link to your clipboard. We'll need it in the next step.
Finally, execute a git clone command to copy the repository to your local machine by typing
Bucky@BSR~$: git clone gitLinkHere
This will create a directory with the most up to date version of the repository. Simply navigate into it and you will be inside the repository. Run git status to make sure you are in a valid git repo.
Bucky@BSR~$: git status
On branch main
Your branch is up-to-date with 'origin/main'.
Before we make any commits, we have to talk about branching. Say you want to make a new feature but are worried about making changes to the main project. This is where git branches come into play.
One important branch is the main branch. This is reserved for our production ready code. Generally, you finish a feature before making it a part of main. On all Badger Solar Racing repos, this is a locked branch requiring a review in order to make changes to main.
Branches allow you to move back and forth between different "states" of a project. All work done in Badger Solar Racing will take place in a separate branch before being a part of main. This way each member can work on a sub-project without interfering with other's work.
Let's create a branch by using the git checkout command with the -b flag. Let's create a branch called {yourname}_tutorial and confirm with the git branch command.
Bucky@BSR~$: git checkout -b Bucky_tutorial
Bucky@BSR~$: git branch
* Bucky_tutorial
main
Let's add a new file to the project in the members/ directory. For this we are going to use the touch command. touch will create an empty file. Create a text file titled by your first and last name and the current semester.
Bucky@BSR~$: touch members/bucky-badger-fa23.txt
Bucky@BSR~$: ls
members README.md
After creating the new file, you can use the git status command to see which files git knows about.
Bucky@BSR~$: git status
On branch Bucky_tutorial
Untracked files:
(use "git add <file>..." to include in what will be committed)
members/
no changes added to commit (use "git add" and/or "git commit -a")
or if the members/ directory already has a file in it that's tracked by git,
Bucky@BSR~$: git status
On branch Bucky_tutorial
Untracked files:
(use "git add <file>..." to include in what will be committed)
members/bucky-badger-fa23.txt
no changes added to commit (use "git add" and/or "git commit -a")
Basically, this means "Hey, we noticed you make a new file called bucky-badger-fa23.txt in members/, but unless you use the git add command, we aren't going to do anything about it.
Git works on a concept called the staging environment, this is one of the most confusing parts of git. Let's go through some terminology.
A commit is a record of what files you have changed since last time you made a commit. Essentially you make changes to the repo (either by adding, deleting, or modifying files) and you "commit" to your changes by telling git to put those files into a commit.
This is where the version control comes in. You can backtrack to any previous commit at any point.
So, how do you tell git which files to put into a commit? This is where the staging environment comes in. As seen in Step 2, when you make changes to your repo, git notices that a file has changed but won't do anything with it. Git will not automatically add your files to a commit
Add a file to the staging environment by using the git add command
Bucky@BSR~$: git add members/bucky-badger-fa23.txt
Bucky@BSR~$: git status
On branch Bucky_tutorial
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
new file: members/bucky-badger-fa23.txt
It's time to create your first commit!
Run the git commit -m "{Your commit message} command.
The -m flag means the next string will be a commit message. It is important to create meaningful commit messages so everyone knows what changes were made. It could be a new feature, fixing a bug, or even just fixing a typo. Please, please, please don't type "asdfasdfasdf" or "whatever".
Bucky@BSR~$: git commit -m "Added my file to members to mark my contribution"
[Bucky_tutorial (root-commit) b345d9a] Added my file to members to mark my contribution
1 file changed, 1 insertion(+)
create mode 100644 members/bucky-badger-fa23.txt
When working with several files, it gets tedious to list every single file for one commit. An easier way to commit several files is to run the git commit command with the -am flag. As we learned earlier, -m means you're adding a message to your commit. The -a flag means you want to commit all changed files.
Bucky@BSR~$: git commit -am "Added my file to members to mark my contribution"
[Bucky_tutorial (root-commit) b345d9a] Added my file to members to mark my contribution
1 file changed, 1 insertion(+)
create mode 100644 members/bucky-badger-fa23.txt
While this can be convenient, it can also be troublesome if you have tentative changes or files that shouldn't be committed, as those could be pulled into the commit without you realizing it.
Now that we are done with our change, we are ready to push it to GitHub. This allows other people to see the changes you've made, and eventually be put into main.
To push changes on a new GitHub Branch we'll use the git push origin {your branch name} command. Origin is just an alias for the repository's url.
Bucky@BSR~$: git push origin Bucky_tutorial
Counting objects: 3, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 313 bytes | 0 bytes/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To https://github.com/badgerloop-software/github-tutorial.git
* [new branch] Bucky_tutorial -> Bucky_tutorial
At this point it may ask you to log in with your username and password.
Finally, if you refresh the GitHub page, you'll see a note of recently pushed branches, yours may be there, or click the "branches" link to see your branch listed there.
A pull request (or PR) is a way to alert the team leads that you want to make some changes to the codebase. It allows them, as well as other Badger Solar Racing members to review the code and make sure it looks good before putting your changes on the main branch.
To start a pull request. Click the "New Pull Request" button on next to your branch.
Be sure to give your PR a meaningful title and description. On the Software team we have a checklist of self-checks to go through before you post a PR. You may see a big green button at the bottom that says "Merge Pull Request" Clicking this means you'll merge your changes into the main branch.
Note If you are doing this tutorial as part of a Software Meeting, you will be required to get a review as if it was a real PR
Note that this button won't always be green. In some cases it'll be grey, which means you're faced with the dreadded merge conflicts. This is when there is a change in one file the conflicts with a change somewhere else (either in that file or elsewhere) and git can't figure out which version to use. You'll have to manually go in an tell git which version to use.
Once the button is green, go ahead and click it. This will merge your changes into the main branch. When you're done, click delete branch as well. This will help with clutter.
Right now the repo on GitHub looks a little different than what you have on your computer. For example, the merge commit you just made doesn't exist on your local machine. We need to get the most recent changes with a git pull command.
Bucky@BSR~$: git checkout main
Switched to branch 'main'
Bucky@BSR~$: git pull
remote: Counting objects: 1, done.
remote: Total 1 (delta 0), reused 0 (delta 0), pack-reused 0
Unpacking objects: 100% (1/1), done.
From https://github.com/badgerloop-software/github-tutorial
* branch main -> FETCH_HEAD
b345d9a..5381b7c main -> origin/main
Merge made by the 'recursive' strategy.
members/bucky-badger-fa23.txt | 1 +
1 file changed, 1 insertion(+)
Yahoo, you've successfully contributed to a repository! Congratulations, this is the foundation of writing code for Badger Solar Racing and will be used nearly every time you work with Badger Solar Racing.
Good luck in your future quest to git gud :)