Created
July 4, 2018 12:36
-
-
Save premkash/95ca6214223363ec7720463db1204058 to your computer and use it in GitHub Desktop.
Template for git commit messages
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# If this commit is applied, it will ...? | |
# Syntax: | |
# Commit Type: Subject (Max 50 chars) | |
#-----------------------------------------------| | |
# (optional body) (Max 72 chars) | |
# Explain the problem this commit is solving. Focus on why you are | |
# making this change as opposed to how (the code explains that). | |
#----------------------------------------------------------------------| | |
# (optional) Reference to tickets, wiki etc?. e.g. | |
# Resolves/Fixes: #23 | |
# See also: #43, #45 | |
#-------------------------------------------- | |
# Commit Type may be : | |
# Feat (new feature) | |
# Fix (bug fix) | |
# Refactor (refactoring prod code) | |
# Style (formatting, missing semi colons, etc; no code change) | |
# Docs (change to documentation) | |
# Test (adding or refactoring tests; no prod code change) | |
# Chore//Nits (version bums, script etc; no prod code change) | |
# ... anything that your team agrees to. | |
# Source: | |
# https://chris.beams.io/posts/git-commit/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
How to configure your git, so that it uses this template file when you want to write a commit message:
git config --global commit.template ~/git-commit.template