Getting Started
Let’s take a look at an example repository on GitHub and then get Git configured on your local computer.
GitHub Web Interface
Log in to GitHub and go to our git-example repository.
The main page of a repository is the “Code” tab, which has a representation of the files, and displays the README
.
Follow this demo to explore the basic features of the GitHub interface and start to understand the concept of a version controlled project:
- Click the “Fork” button in the upper right–you now have your own personal version of the repo! Forking is a GitHub concept that allows you to create a new copy of a repository, yet maintain a connection so that changes can be sent back to the original via “Pull Requests” (PR). It is a common workflow for collaborating on bigger projects.
- On your
git-example
web page, click the “Commits” button below the description. The Commits page allows you to review and navigate the entire history of the repo. - Click back on the “Code” tab, then click on one of the file names. This will display the file’s contents on the page.
- Click the edit pencil on the upper right side of the document to open the web editor.
- Make some changes or add some new text, then scroll down to the “Commit Changes” box.
- Enter a commit message and click the green button to save your edits to the history. You just made your first commit–you used Git! You added one snapshot to the history.
- Click back to the “Code” tab and “Commits” to view your updated history.
Note: GitHub allows Markdown formating for READMEs and comments through out the site.
Create a New Repository
The most common way to work with Git is to create or fork a repository on GitHub, then clone
it to your local machine.
You will then work on the files locally, before using push
to send your changes to the “remote” repository.
To create a new remote repository:
- Click the plus sign on the upper right and select “New repository” from the drop down
- Give it a nice name
- Check “Initialize this repository with a README”
- Click “Create repository”
Every GitHub repo has handy project management features builtin. Check the Issues, Projects, and Wiki tabs to start organizing your work! To delete a repository, click on the “Settings” tab and scroll down to the bottom to find the delete button.
Git Config
To start learning Git we will use it on the command line. Although there are GUI clients to manage Git repositories, being familiar with the command line version will help you better understand the basic workflow. If you need a command line refresher, check out this mini-lesson. So fire up your favorite shell, terminal, or Git Bash to get started!
Some initial setup is necessary the first time you use Git on a computer. You will use these commands only once, unless you want to change something.
Set your name and email (matching your GitHub account):
git config --global user.name "Evan Will"
git config --global user.email "myemail@gmail.com"
Your email and user name is recorded with every commit. This helps ensure integrity and authenticity of the history. Most people keep their email public, but if you are concerned about privacy, check GitHub’s tips to hide your email.
Next, set your default text editor.
The current versions of the Git for Windows installer allow you to set the default editor during setup, so Windows users should not need to complete this step and should have nano set as the default editor.
In general Linux and Mac users should set their Git core.editor
to "nano -w"
as well.
Nano is a basic command line editor that is fairly easy to use.
Set the default editor with this command:
git config --global core.editor "nano -w"
Git opens the default editor to ask for commit messages. You are most likely to encounter it when merging. If you don’t set a default editor, Git will use the default default–which might be surprising if you are not used to terminal-based editors such as Vim. If you are stuck in Vim and can’t figure out how to escape, type
Esc
then:wq
thenEnter
to save and quit (VIM quick ref, and don’t worry, you are not alone in confusion).
With our test repository ready and Git configured, we can move on to the basic Git workflow!
Create Repository Locally
P.s. If you really want to, you can create a local repository:
mkdir test
cd test
git init
If you want to connect this repository to GitHub, you have to git remote add
.
Generally, it is easier to create the repo on GitHub first and clone
, rather than using init
.
However, init
is useful if you will not be pushing to a remote repo.