{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Git \n", "\n", "\n", "Like most tools we present in this course there is a difference between what `git` can do and what you should know about it. \n", "\n", "## What is Git?\n", "\n", "`Git` is a distributed version control system that tracks versions of files. It is often used to control source code by programmers who are developing software collaboratively\n", "([Wikipedia](https://en.wikipedia.org/wiki/Git)).\n", "\n", "In the introductory lecture we mentioned [GitHub Desktop](https://github.com/apps/desktop) which is a very useful \n", "app to learn `git` from a graphical user interface (GUI), rather than from the command line interface (CLI).\n", "\n", "\n", "## Git platforms\n", "\n", "\n", "There are three main platforms hosting git repositories on the web:\n", "\n", "- [GitHub](https://github.com)\n", "- [GitLab](https://gitlab.com)\n", "- [BitBucket](https://bitbucket.org)\n", "\n", "In this course we use GitHub and Gitlab. \n", "\n", "GitHub is the most popular (as of now), and GitLab is the one contracted by the University (also very popular).\n", "\n", "Here we focus on GitHub. The workflow is almost identical for GitLab, it is just \n", "the web interface that is slightly different.\n", "\n", "## Forks \n", "\n", "If you are working on a project already hosted on github \n", "you should fork it to your account. This will allow you to modify it,\n", "keep track of what you are doing, and contribute to it. \n", "\n", "To fork a repo you can click on the `fork` button on the top right of the repository github page.\n", "\n", "
\n", "**Exercise:** fork the repository [ResearchComputing](https://github.com/borisbolliet/ResearchComputing) to your account.\n", "
\n", "\n", "\n", "## Clones\n", "\n", "A clone is a copy of a repository. You can clone any github repository to your account \n", "with the `git clone` command. \n", "\n", "
\n", "**Exercise:** clone **your fork** of the repository [ResearchComputing](https://github.com/borisbolliet/ResearchComputing) to your account.\n", "
\n", "\n", "## Branches\n", "\n", "A git repository can have many branches which intend to develop different features of the project.\n", "At some point, changes from different branches can be merged together.\n", "When changes are approved by project owners, they can be merged into the main branch.\n", "\n", "To look at the branches in your repository use: \n", "\n", "```bash\n", "git branch -a\n", "```\n", "\n", "The `-a` option shows all branches, including remote ones. A star `*` will appear next to the branch you are currently on.\n", "\n", "To switch to an existing branch use: \n", "\n", "```bash\n", "git switch \n", "```\n", "\n", "To create a branch use: \n", "\n", "```bash\n", "git switch -c \n", "```\n", "\n", "## Pulls\n", "\n", "When multiple people are collaborating on a same repository, it is possible that your local branch is out of date because someone else has made an update. To check the status of your local branch, use:\n", "\n", "```bash\n", "git status\n", "```\n", "\n", "If the `git status` command shows that your branch is behind the origin branch, you can update it with:\n", "\n", "```bash\n", "git pull\n", "```\n", "\n", "Try to do this every time before you start working on the repository, as otherwise when you stage and commit changes (see next paragraph) you may find yourself in trouble caused by file conflict.\n", "\n", "## Commits\n", "\n", "Commits are what allow you to keep track of what you are doing.\n", "You can check status of your files by typing: \n", "\n", "```bash\n", "git status\n", "```\n", "\n", "And you can see the commit history with: \n", "\n", "```bash\n", "git log\n", "```\n", "\n", "If the `git status` shows that some files have been modified, you can stage them for commit with: \n", "\n", "```bash\n", "git add ...\n", "```\n", "\n", "or all of them with: \n", "\n", "```bash\n", "git add .\n", "```\n", "\n", "To commit your changes use: \n", "\n", "```bash\n", "git commit\n", "``` \n", "\n", "This will open an editor like `vim` where you can write a commit message. You \n", "can exit the editor by pressing `Esc` then `:wq`.\n", "\n", "You can push your changes to the remote repository with: \n", "\n", "```bash\n", "git push\n", "```\n", "\n", "## Pull requests\n", "\n", "Pull requests are used to merge changes from your branch into the main branch of the remote repository \n", "(the original one, not your fork if you have one).\n", "\n", "You can do this online, on the web interface of the repository.\n", "\n", "The pull request are reviewed by the owner, which can also do it via the web interface. \n", "\n", "\n", "## Updating your fork\n", "\n", "To update your fork, you can use the web interface of GitHub.\n", "\n", "## Merge changes between branches\n", "\n", "You can update your branches by merging changes from one branch into another\n", "\n", "Switch to the branch you want to update: \n", "\n", "```bash\n", "git switch \n", "``` \n", "\n", "And then merge the changes from the branch you want to update into the current branch with: \n", "\n", "```bash\n", "git merge \n", "```\n", "\n", "
\n", "**Exercise:** Practise all of these steps with our course repository.\n", "If you have GitHub Desktop, try to do all of these steps on GitHub Desktop instead of the command line.\n", "
\n", "\n", "\n", "\n", "\n", "\n" ] } ], "metadata": { "language_info": { "name": "python" } }, "nbformat": 4, "nbformat_minor": 2 }