git commit templates

# <type>: (If applied, this commit will...) <subject> (Max 50 char)
# |<----  Using a Maximum Of 50 Characters  ---->|


# Explain why this change is being made
# |<----   Try To Limit Each Line to a Maximum Of 72 Characters   ---->|

# Provide links or keys to any relevant tickets, articles or other resources
# Example: Github issue #23

# --- COMMIT END ---
# Type can be
#    feat     (new feature)
#    fix      (bug fix)
#    refactor (refactoring production code)
#    style    (formatting, missing semi colons, etc; no code change)
#    docs     (changes to documentation)
#    test     (adding or refactoring tests; no production code change)
#    chore    (updating grunt tasks etc; no production code change)
# --------------------
# Remember to
#    Capitalize the subject line
#    Use the imperative mood in the subject line
#    Do not end the subject line with a period
#    Separate subject from body with a blank line
#    Use the body to explain what and why vs. how
#    Can use multiple lines with "-" for bullet points in body
# --------------------
# For more information about this template, check out
# https://gist.github.com/adeekshith/cd4c95a064977cdc6c50

---

git

Adding a remote

1. Reinitialize your local repo; also clearing remote repos (ie origin):

$ git init

2. Then, will create 'origin' if it doesn't exist:

$ git remote add origin [repo-url]

Else, you can use the set-url subcommand to edit an existing remote:

$ git remote set-url origin [repo-url]

3. Also, you can check existing remotes with

$ git remote -v

Syncing a fork

0. Add remote(call it "upstream") from original repository in your forked repository.

$ git remote add upstream https://github.com/whoever/whatever.git

1. Fetch the branches and their respective commits from the upstream repository. Commits to master will be stored in a local branch, upstream/master.

$ git fetch upstream

2. Check out your fork's local master branch.

$ git checkout master

3. Merge the changes from upstream/master into your local master branch. This brings your fork's master branch into sync with the upstream repository, without losing your local changes.

$ git merge upstream/master

Features

Command	Description
git clean -d -f .	Clear the untracked files from the local
git reset --hard upstream/master	Delete all your local changes to master

Branch & Merge

Command	Description
git branch	List branches (the asterisk denotes the current branch)
git branch -a	List all branches (local and remote)
git branch [branch name]	Create a new branch
git branch -d [branch name]	Delete a branch
git branch -D [branch name]	Delete a branch with --delete --force, which deletes the branch regardless of its push and merge status
git push origin --delete [branch name]	Delete a remote branch
git checkout -b [branch name]	Create a new branch and switch to it
git checkout -b [branch name] origin/[branch name]	Clone a remote branch and switch to it
git checkout [branch name]	Switch to a branch
git checkout -	Switch to the branch last checked out
git checkout -- [file-name.txt]	Discard changes to a file
git merge [branch name]	Merge a branch into the active branch
git merge [source branch] [target branch]	Merge a branch into a target branch
git stash	Stash changes in a dirty working directory
git stash list	List all stash changes
git stash pop	Remove a single stashed state from the stash list and apply it on top of the current working tree state
git stash apply	Like pop, but do not remove the state from the stash list
git stash clear	Remove all stashed entries

---

gitflow vs. git

Initialize

gitflow	git
git flow init	git init
	git commit --allow-empty -m "Initial commit"
	git checkout -b develop master

Connect to the remote repository

gitflow	git
N/A	git remote add origin git@github.com:MYACCOUNT/MYREPO

Features

Create a feature branch

gitflow	git
git flow feature start MYFEATURE	git checkout -b feature/MYFEATURE develop

Share a feature branch

gitflow	git
git flow feature publish MYFEATURE	git checkout feature/MYFEATURE
	git push origin feature/MYFEATURE

Get latest for a feature branch

gitflow	git
git flow feature pull origin MYFEATURE	git checkout feature/MYFEATURE
	git pull --rebase origin feature/MYFEATURE

Finalize a feature branch

gitflow	git
git flow feature finish MYFEATURE	git checkout develop
	git merge --no-ff feature/MYFEATURE
	git branch -d feature/MYFEATURE

Push the merged feature branch

gitflow	git
N/A	git push origin develop
	git push origin :feature/MYFEATURE (if pushed)

Releases

Create a release branch

gitflow	git
git flow release start 1.2.0	git checkout -b release/1.2.0 develop

Share a release branch

gitflow	git
git flow release publish 1.2.0	git checkout release/1.2.0
	git push origin release/1.2.0

Get latest for a release branch

gitflow	git
N/A	git checkout release/1.2.0
	git pull --rebase origin release/1.2.0

Finalize a release branch

gitflow	git
git flow release finish 1.2.0	git checkout master
	git merge --no-ff release/1.2.0
	git tag -a 1.2.0
	git checkout develop
	git merge --no-ff release/1.2.0
	git branch -d release/1.2.0

Push the merged feature branch

gitflow	git
N/A	git push origin master
	git push origin develop
	git push origin --tags
	git push origin :release/1.2.0 (if pushed)

Hotfixes

Create a hotfix branch

gitflow	git
git flow hotfix start 1.2.1 [commit]	git checkout -b hotfix/1.2.1 [commit]

Finalize a hotfix branch

gitflow	git
git flow hotfix finish 1.2.1	git checkout master
	git merge --no-ff hotfix/1.2.1
	git tag -a 1.2.1
	git checkout develop
	git merge --no-ff hotfix/1.2.1
	git branch -d hotfix/1.2.1

Push the merged hotfix branch

gitflow	git
N/A	git push origin master
	git push origin develop
	git push origin --tags
	git push origin :hotfix/1.2.1 (if pushed)

---

Aliases

Alias	Command	Description
gfl	git flow	Git-Flow command
gfli	git flow init	Initialize git-flow repository
gcd	git checkout develop	Check out develop branch
gch	git checkout hotfix	Check out hotfix branch
gcr	git checkout release	Check out release branch
gflf	git flow feature	List existing feature branches
gflh	git flow hotfix	List existing hotfix branches
gflr	git flow release	List existing release branches
gflfs	git flow feature start	Start a new feature: gflfs <name>
gflhs	git flow hotfix start	Start a new hotfix: gflhs <version>
gflrs	git flow release start	Start a new release: gflrs <version>
gflff	git flow feature finish	Finish feature: gflff <name>
gflfp	git flow feature publish	Publish feature: gflfp <name>
gflhf	git flow hotfix finish	Finish hotfix: gflhf <version>
gflrf	git flow release finish	Finish release: gflrf <version>

---

References

• http://nvie.com/posts/a-successful-git-branching-model/
• https://help.github.com/articles/using-pull-requests#shared-repository-model
• https://gist.github.com/JamesMGreene/cdd0ac49f90c987e45ac
• https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/git-flow/README.md
• Personal experience