Welcome! In this tutorial you're going to learn:
- Basic command-line use
- How to install/configure git
- How to edit files in emacs/vim/atom or your fav editor
- Simple git usage (diffs, commits, etc.)
- Simple collaboration exercise in Python
- Using Github with your Visual Studio project
- Simple collaboration exercise in C
- How to navigate and use Github
Let's get started.
Git is Version Control Software. You may have heard of others like svn.
Git allows you to save your work and maintain a visible history of that
work. You can even revert to previous stages of your history, and make
multiple branches of that history for experimentation.
Git is great for working in groups as well, because the history of who did what and when they did it is completely transparent.
We recommend you follow this visual guide and complete the first three tasks before continuing with the tutorial below.
Programs in Linux are never downloaded and installed from websites like they are with Windows or Mac. Every Linux distribution has a package manager, which when asked for a program, downloads it and its dependencies from the central servers of your distro and installs them exactly where your system expects them to be in order to be used.
Antergos and Manjaro are children of Arch, meaning they share a lot, including a package manager. Do the following in a terminal to get git:
pacman -S git
-S means sync and will download any package you ask it for.
All these three are actually children/grandchildren of the very first Linux distribution, Debian. Hence they all use the same packaging software. Do the following in a terminal to get git:
apt-get install git
These distros also have graphical packaging software, but for now let's get used to using the command line.
Git needs to know who you are. Enter the following two commands into your terminal:
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
Every time you make a commit with git, your information will be associated with that commit. This makes it very clear who changed what and when in a project.
Make a Github account if you haven't already. What Github is is a site to host your code (your repos). What it allows is a collaborative coding environment. Users can comment on code, create issues (for bugs), copy repos, and merge their changes together.
The CSSS uses Github to store our documents, and you can use it to keep all your future coding projects backed up, including code you write for your classes.
Q: But shadowy CSSS git tutorial narrator, why would I want to put all my code up on the internet? Won't people find my stuff and copy it?
A: Github actually has a student pack which gives you loads of free access to various web services. Notably:
- Free Github Micro Account (5 Private Repos. No one else can see your code.)
- $100 credit for DigitalOcean (web hosting. Their cheapest server is $5/month, meaning you get 20 months to do whatever you want with a server.)
- Free
.medomain name for a year with Namecheap.
In the top-right corner of this Github page you should see a button
labeled Fork. Click it.
You now have a perfect copy of this repo that exists on your Github account. You can do whatever you want to it.
Forking generally means one of two things:
- Copying a project's code and taking it in a new direction for philosophical/political reasons, or;
- Making a copy of a project on Github.
Move back to your terminal. We're now going to clone the repo you just forked.
Cloning is the process of copying a remote repo (like on Github) to your own machine to work on.
Using cd (change directory), move to a directory using you'd like
your clone to be in, and enter the following:
git clone https://github.com/your-github-account/csss-git.git
Use ls and you should see the csss-git folder. It contains the
contents of the repo. You can make whatever changes you want to it;
nothing on Github will be affected until you make a git push.
Thsi si a teriblee speld sentins.
Fix the sentence above in an editor of your choice. We
recommend emacs, vim, or Sublime Text. In particular,
emacs and vim run in the terminal. Since you're going to
be spending a lot of time there, you might as well get used to
them.
C refers to your control/ctrl button.
- Save a change:
C-x C-s - Leave emacs:
C-x C-c
In vim you have to type i or a to enter Insert Mode before you
can type. i enters Insert Mode before the cursor, while a enters after
the cursor. Esc puts you back into Normal Mode. You need to
be in Normal Mode to run the commands below:
- Save a change:
:w - Leave vim:
:q - Do both at once:
:wq - Leave without saving changes:
:q!
Use git diff to see what changes you've made since your last commit.
When you want to track a new file you've added to your project,
use git add thefilenamehere. Since README.md is already tracked
by the project, we can just use git commit -a, which prepares
all files you've changed this time around to be committed.
git commit -a will open up an editor for you to write a commit
message in. Once you do so, and then save and leave, the commit
will be made.
Advice: Writing good commit messages is important. Future you (or a coworker) will love you for it, trust me. Here's a terrible commit:
commit 2e4c6df191cdb6597464122d05adae61c314e91f
Author: Colin Woodbury <[email protected]>
Date: Tue Sep 11 18:59:22 2012 +0900
Fixed a bug
What was the problem? Where was it? How did you fix it?
Here's a good commit:
commit 71c26a15c9f2f763028e34c6ddde83b1763d93d0
Author: Colin Woodbury <[email protected]>
Date: Sat Jan 3 09:19:48 2015 -0800
(Aura1): Success code given when `--needed` finds nothing to do - fixes #299
- This is what pacman does, and is helpful for scripts.
- In fixing this I found more weird behaviour:
`pacman -S` gives 1 (bad) saying there's nothing to do.
`aura -A` gives 0 (good) saying nothing.
Here we see:
- The title describes new behaviour.
- A github issue is referenced (and actually closed) by this commit.
- Some reasoning was given for the change.
- Further problems can be addressed.
Now that you've made a commit, let's confirm it with
git log. You should see a list of all the recent commits,
with the one you just made at the top.
If you screwed up your latest commit message, you can change it
with git commit --amend.
However we're going to completely delete the commit you just
made. Remember HEAD from Learn Git Branching? Here are
two handy commands:
git reset --hard HEAD: Deletes all your current uncommitted changes.git reset --hard HEAD^: Deletes your latest commit.
Do the second one to kill your commit.
That's pretty much all we have to teach you right now. There's more of
course, but the info here is a good start. See the file COMPLETED.md? Add
your name and the date to it, and commit the change.
The commit you made is local to your machine. By Pushing, we can sync your Clone and your Fork, and your new commit will then be on Github too.
git push origin master
Okay, the commit is now in your Fork too. But its still not in the original repo you copied in the first place. By making a Pull Request from your Fork you can ask the maintainers of the original repo to merge your changes into the master project.
On your Fork's page on Github, there should be a Green button near the upper-left. Click that, then hit Create Pull Request on the next page. This will create a new Issue in the main repo, where everyone can discuss your commits. The maintainers may ask you to make further changes before they merge.
Pretty soon the csss-git repo maintainers should merge your commit
in, and you'll be forever remembered for having completed this tutorial.
The above process is how modern collaborative software development is done. By getting a handle on it now, you'll have a head-start in your co-op placements and other real job placements. Good luck!
If you have any questions, feel free to ask us! Click on "Issues" on the right and open a new issue.