-
-
Save Pepeye/e7f4210c46ff939021ac8a29ccc901ce to your computer and use it in GitHub Desktop.
This commit message template helps you write great commit messages and enforce it across teams.
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
# <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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Also check out the useful git flow approach and leverage above commit template
https://danielkummer.github.io/git-flow-cheatsheet/
Save
$ git config --global commit.template <Absolute OR Relative path to .gitmessage.txt file
e.g.
$ git config --global commit.template ~/.git_commit_msg.txt