Github documentation

Git commands;

1. clone clone a repository from Github to my computer.
2. add track files & changes in Git. ( use git add . to track and save all changes in repo).
3. commit save files to Git.
4. push upload Git commits to Github.
5. pull download changes from Github to my computer (the opposite to push).

Creating a new repository in Github

1. Go to Github
2. Click plus in top right and new repository
3. Name repo, set privacy settings and click create
4. Click creating a new file
5. Name file, README.md

Pulling a repo from Github to VS Code

1. Open VS Code
2. Go to the terminal
3. In Github, go to repo, click code and copy clone HTTPS link
4. Back in terminal, go to the folder where I want to save repo by using cd (folder name)
5. Write git clone (clone link)
6. In terminal, move into git folder by typing cd (name of folder)

Saving changes to Github

1. In terminal, write git status to check status of what has not been saved or tracked.
2. To save/track, write git add . to save and track all changed in repo.
3. To commit changes, write git commit -m "(commit message goes here)" -m "(description goes here)"
4. To push changes, write git push origin master (origin is the location of the git repo & master is the name of the branch to push to)

Creating a repository locally

1. In terminal, write cd to go to the folder of the project.
2. To initialize a new repo, write git init or git config --global init.deafultbranch {name}
3. Save/track, write git add . to save and track all changed in repo.
4. Commit changes, write git commit -m "(commit message goes here)" -m "(description goes here)"
5. Go to Github and make a new repository.
6. Copy HTTPS or SSH link for repo and write in terminal git remote add origin (paste Github link)
7. Check any connected repository by writing git remote -v
8. To push changes, write git push -u origin master (after creating an upstream with -u we can then just write git push in the future)

Github Workflow

1. Write code
2. Stage changes git add .
3. Commit changes git commit
4. Add & commit changes git commit -am (commit title) (only works for modified files, not newly created files)
5. Push changes git push
6. Make pull request

Git branching

• Master branch is where all the main code lives.
• Create new branches when creating new features to applications to test before merging to master or for bug fixing.
• Branches are like staging environments before merging to master.
• Type git branch to see what branches there are.

How to use Git branching

1. git checkout (name of branch) to change between branches.
2. git checkout -b (name of branch) to create a new branch.
3. git diff -b (name of branch) to compare changes of 2 branches.
4. git merge to merge branches locally (only used to merge all local branches to local master if other people are constantly merging to master in Github)
5. Once changes are pushed, open a pull request in Github.
6. Review pull request and then merge changes to the master branch.
7. git pull to pull down the changes from Github.
8. git branch -d (name of branch) to delete a branch.

Branch structure

Permanent branches

1. Master
2. Dev

Temporary branches

1. New feature branches
2. Bug fixing branches

Branch conflicts

When a team is working on different branches at the same time, and pushing changes to the master branch, sometimes the same files get modified and Github does not know which version to keep, which creates a conflict.

1. Unable to switch branches if multiple branches have conflicting files. (changes need to be commited first)
2. git merge to merge branches locally (only used to merge all local branches to local master if other people are constantly merging to master in Github)
3. If conflict emerges when merging branches locally, review conflicts in VS Code and save changes.
4. Commit changes after fixing conflict issues.

Undoing mistakes in Github

1. git reset undoes a git staging.
2. git reset HEAD~1 undoes a commit.
3. git log to see a log of all commits.
4. git reset (commit code from log) goes unstage to an older commit.
5. git reset --hard (commit code from log) removes changes to an older commit.

Forking in git

Forking code is cloning someone elses public repo from Github.

List of sources

Colt Steeles web developer bootcamp 2021

Intro to Github