Skip to content

Latest commit

 

History

History
87 lines (79 loc) · 3.99 KB

git.md

File metadata and controls

87 lines (79 loc) · 3.99 KB
Raw

Getting started with Git Version Control (Assuming you have a GitHub account)

Disclaimer: This is not exhaustive, only for hitchhiking

Setup git

  1. Download git sudo get-apt install git
  2. Setup Git Proxy (if required) git config --global http.proxy http://proxyuser:[email protected]:8080
  3. Set your Git username for every repository on your computer git config --global user.name "Your name"
  4. Set your Git email for every repository on your computer git config --global user.email "[email protected]"

Case #1 Remote to Local i.e. Get a GitHub Repo to your local sytem

If you want to get a copy of an existing Git repository — for example, a project you’d like to contribute to.

  1. Open a terminal and go to folder where you want to download the repo cd /path/to/folder
  2. Go to the repo on GitHub and get the URL 'Clone or Download > Clone with HTTPS' Copy the URL (It will be something like https://github.com/path/to/repo')
  3. Clone a repo from GitHub using the URL git clone https://github.com/path/to/repo This creates a new subdirectory which has the repo

Case #2 Local to Remote i.e. Sync repo on your local with GitHub

If you have a project directory that is currently not under version control and you want to start controlling it with Git

  1. Open a terminal and go to folder cd /path/to/folder
  2. Initialize a git repo locally git init This creates a new subdirectory named .git that contains all of your necessary repository files.
  3. Go to the repo on GitHub and get the URL. (Create a new repo, if you haven't done it) 'Clone or Download > Clone with HTTPS' Copy the URL (It will be something like https://github.com/path/to/repo')
  4. Setup remote which is where your local repo will be pushed and fetched git remote add origin https://github.com/path/to/repo. To update the url for origin use git remote set-url origin instead.
  5. Check the remote git remote -v

Working with the local repo

To discard all local changes. git reset --hard origin/master. OR

  1. After making changes, Add the files in your local repository. This stages them for the commit. git add . This adds all files to be tracked
  2. Now commit the files on the staging area. As a convention, commit after making meaniful changes (like fixed bug, added feature), even if it is a one code line change git commit -m "Initial Commit"
  3. Push all changes git push origin master
  4. Pull latest git pull origin master

Tell git to ignore some file

Used to ignore log files, build files .pyc, .o etc

Merge Conflict (Please read)

Working with a forked repo

Making an existing repo as your starting point

  • For the repo on GitHub and clone the foked version repo
  • Ensure the fetch and push path point correctly. I use origin as my forked repo and upstream as the original repo.
$ git remote -v
> origin    https://github.com/YOUR_USERNAME/YOUR_FORK.git (fetch)
> origin    https://github.com/YOUR_USERNAME/YOUR_FORK.git (push)
> upstream  https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch)
> upstream  https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push)
  • To update url of existing remote
git remote set-url origin https://github.com/USERNAME/REPOSITORY.git
  • To add a new remote
git remote add upstream https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git

References: