Skip to content

Instantly share code, notes, and snippets.

@rokumatsumoto
Forked from adeekshith/.git-commit-template.txt
Created February 25, 2019 08:17
Show Gist options
  • Save rokumatsumoto/464e7b32bd15188cf22ad52e4cecc10f to your computer and use it in GitHub Desktop.
Save rokumatsumoto/464e7b32bd15188cf22ad52e4cecc10f to your computer and use it in GitHub Desktop.
This commit message template helps you write great commit messages and enforce it across teams.
# <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
@rokumatsumoto
Copy link
Author

To apply the template,
Save the above file to your local machine and use
git config --global commit.template <.git-commit-template.txt file path>
For example, if you saved it to your home folder, try:
git config --global commit.template ~/.git-commit-template.txt
In your .gitconfig file

[commit]
  template =  ~/.git-commit-template.txt

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment