This repository has been archived on 2023-11-08. You can view files and clone it, but cannot push or open issues or pull requests.
How-To-Git-Started/README.md

189 lines
4.8 KiB
Markdown

Table of Contents
=================
* [Table of Contents](#table-of-contents)
* [How to Git started](#how-to-git-started)
* [Using a GUI](#using-a-gui)
* [Learning objectives](#learning-objectives)
* [Assignments](#assignments)
* [Assignment 1: Create a repository](#assignment-1-create-a-repository)
* [Assignment 2: Your first commit](#assignment-2-your-first-commit)
* [Assignment 3: Merge conflicts](#assignment-3-merge-conflicts)
* [Assignment 5: Branching](#assignment-5-branching)
* [Assignment 6: Merge branches (Or Rebase)](#assignment-6-merge-branches-or-rebase)
* [Assignment 7: Pull requests](#assignment-7-pull-requests)
* [Assignment 8: Undo / Revert commit](#assignment-8-undo--revert-commit)
* [Assignment 9:](#assignment-9)
* [Using the terminal](#using-the-terminal)
* [Getting started](#getting-started)
* [Terminal commands](#terminal-commands)
# How to Git started
## Using a GUI
You can use any GUI for git, the ones we use are Fork and Sourcetree <br/>
You can download these at https://www.sourcetreeapp.com/ and https://git-fork.com/
For other GUIs check out https://git-scm.com/downloads/guis/
Our remote git server is located at https://git.web.rug.nl/ <br/>
You can log in with your usual p-number and password.
Cheatsheets:
[Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
## Learning objectives
- Introduction to VCS
- Create new repository
- README.md
- Git ignore file
- Staging
- Committing
- Git push
- Git pull request
- Branching
- Merge / Rebase
- Amend commits
- Revert and reset
- Tag
- Log
## Assignments
### Assignment 1: Create a repository
1. Create your own new repository
2. Add a .gitignore file
3. Why you would like a gitignore file
4. Not pushing sensitive files
5. Not pushing environment files
6. Add a README
### Assignment 2: Your first commit
0. Clone repository
0. Edit README file
0. Create a new file(s) and add information
0. Stage README and your file(s)
0. Commit README and your file(s)
### Assignment 3: Merge conflicts
0. Go to the How to Git started repository
0. Add factorial.py and fibonacci.py to your repository
0. Choose a partner
0. Add him/her as a collaborator
0. Make the partner clone your repository
0. Let both of you edit the same line in the code file
0. Let one of you stage and push the changes
0. Solve the merge conflict
### Assignment 5: Branching
0. Go to the How to Git started repository
0. Add index.html to your shared repository.
0. Let person A create a new branch called header
0. Let person B create a new branch called footer
0. Let person A edit the header of index.html
0. Let person B edit the footer of index.html
0. Stage and push the changes
0. Pull the latest changes
0. Track the branch of your partner
### Assignment 6: Merge branches (Or Rebase)
0. Go to your master branch
0. Merge it with the header branch
0. Commit the merge
0. Merge it with the footer branch
0. Commit the merge
0. Push the changes
0. Delete your old branches
### Assignment 7: Pull requests
0. Let one of you create a new repository (do not add collaborators)
0. Stage and commit a file
0. Let the other person fork the repository and clone it
0. Let him/her change the file and push it
0. Let him/her create a new pull request via the GUI
0. Let the other approve and merge the request
0. Let the other pull the latest changes
### Assignment 8: Undo / Revert commit
### Assignment 9:
Check the logs
## Using the terminal
### Getting started
Set up your git info
```shell
*** Please tell me who you are.
Run
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
to set your account's default identity.
Omit --global to set the identity only in this repository.
```
If you want to save your https credentials run
```shell
git config --global credential.helper store
Omit --global to set the identity only in this repository.
```
Or you can add an [SSH key](https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)
### Terminal commands
See changes that have been made
```shell
git diff
```
Adding files to commit
```shell
git add file1 file2
git add *
```
Committing files with commit message
```shell
git commit -m "your commit message"
```
unstage by using
```shell
use "git reset HEAD <file>..." to unstage
```
Creating a new branch
```shell
git branch <branchname>
git checkout -b <branchname>
```
Going to different branch
```shell
git checkout <branchname>
```
Seeing available branches
```shell
git branch -a
```
Track remote branch
```shell
git checkout --track origin/<branch>
```
Delete remote branch
```shell
git push <remote_name> --delete <branch_name>
git remote prune <remote_name>
```
Check the log in graph form
```shell
git log --graph --oneline
```