Skip to content

Latest commit

 

History

History
257 lines (168 loc) · 6.74 KB

git.md

File metadata and controls

257 lines (168 loc) · 6.74 KB

Mastering Git Workflow

alt text

Git is an open source program for tracking changes in text files. It was written by the author of the Linux operating system, and is the core technology that GitHub, the social and user interface, is built on top of.

Table of Contents

Setting up Git
Initializing the Repository
From SVN to Git Adding a file
Committing Changes
Pushing to a Remote Repository
Pulling from the Remote Repository
Branching
Opening a Pull Request
Mergin youe Pull Request

Documentations

Cheat Sheet
Git Reference

Setting up Git

  1. Download and install the latest version of Git.
  2. Register your user name.
git config --global user.name "YOUR NAME"
  1. Register your email.
git config --global user.email "YOUR EMAIL ADDRESS"

Authentication

Your authentication depends if you use HTTPS or SSH protocol.

HTTPS

If you clone with HTTPS, you can use a credential helper to tell Git to remember your GitHub username and password every time it talks to GitHub. With Git for Windows, running the following in the command line will store your credentials:

git config --global credential.helper wincred

SSH

If you clone with SSH, your SSH keys will be automatically used.

Initializing the Repository

A repository is the most basic element of GitHub. They're easiest to imagine as a project's folder. A repository contains all of the project files (including documentation), and stores each file's revision history. Repositories can have multiple collaborators and can be either public or private.

From the terminal, navigate to the root directory of your project and enter git init to generate a new Git repository.

mkdir [project-name]
cd [project-name]
git init
echo "me" >> contributors.txt
git a .
git commit -m "first commit"
git push origin master

From GitHub Web Interface

  • In the upper-right corner of any page, click +, and then click New repository
  • Create a short name
  • Choose between creating a public or private repository.
git clone [url]

On Tortoize

//TODO

From SVN to Git

git svn clone http://my-repository/svn/
  • List all developers
git shortlog -sn
  • Create users.txt and import
bclaveau = Benoît Claveau <[email protected]>

git svn clone http://my-repository/svn/ --authors-file=users.txt --no-metadata
  • Tags all SVN tags
git for-each-ref refs/remotes/tags | cut -d / -f 4- | grep -v @ | while read tagname; do
git tag "$tagname" "tags/$tagname"; git branch -r -d "tags/$tagname";
done
  • Branches all SVN branches
git for-each-ref refs/remotes/tags | cut -d / -f 4- | grep -v @ | while read tagname; do
git tag "$tagname" "tags/$tagname"; git branch -r -d "tags/$tagname";
done

Adding a File

We need to add some files to be version controlled. This can be accomplished by adding specific files by name using the git add command:

git add .

On Tortoize

//TODO

Committing Changes

Once a change has been made, it is best practice to commit that change to the repository. All commitments in Git require a commit message

git commit -am "this is my local commit I want to push to remote repository"

On GitHub

  1. Click the pencil icon in the upper right corner of the file view to edit.
  2. Modify the file.
  3. Write a commit message that describes your changes.
  4. Click Commit changes button.

alt text

On Tortoize

//TODO

Warning: if you created new file, you need to add it to your local repository before committing.

Pushing to a Remote Repository

Pushing refers to sending your committed changes to a remote repository. For instance, if you change something locally, you'd want to then push those changes so that others may access them.

git push

On Tortoize

//TODO

Pulling from the Remote Repository

Pull refers to when you are fetching in changes and merging them. For instance, if someone has edited the remote file you're both working on, you'll want to pull in those changes to your local copy so that it's up to date.

git pull

On Tortoize

//TODO

Once the local repository is updated, any conflicting files will be observed and conflicts must be resolved, after which point editing can begin as normal until the local repository needs to be pushed back to the remote repository once again, and the process repeats until development is complete!

Branching a repository

Branching is the way to work on different versions of a repository at one time.

By default your repository has one branch named master which is considered to be the definitive branch. We use branches to experiment and make edits before committing them to master.

When you create a branch off the master branch, you’re making a copy, or snapshot, of master as it was at that point in time. If someone else made changes to the master branch while you were working on your branch, you could pull in those updates.

alt text

To create a new branch

git branch [branch name]
git checkout [branch name]

On GitHub

  1. Click the drop down at the top of the file list that says branch: master.
  2. Type a branch name.
  3. Select the blue Create branch box or hit “Enter” on your keyboard.

alt text

On Tortoize

//TODO

Opening a Pull Request

Pull Requests are the heart of collaboration on GitHub. When you open a pull request, you’re proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch.

As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.

  1. Click the green New pull request button.
  2. Select your feature branch to compare with master.
  3. Submit your Pull Request.

Mergin your Pull Request

Merging your feature branch into the master branch.

On GitHub

  1. Click the green Merge pull request button to merge the changes into master.
  2. Click Confirm merge.
  3. Delete your feature branch.