Skip to content

Instantly share code, notes, and snippets.

@rpdelaney
Last active April 25, 2019 20:23
Show Gist options
  • Save rpdelaney/41651befb2326a19aafec4660ff315e9 to your computer and use it in GitHub Desktop.
Save rpdelaney/41651befb2326a19aafec4660ff315e9 to your computer and use it in GitHub Desktop.
git commit template
# (If applied, this commit will...)
# |<---- Using a Maximum Of 50 Characters ---->|
# Explain what this changes and why (avoid "how")
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# Provide links or keys to any relevant tickets, articles or other resources
# Example: - Fixes #32
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# --- COMMIT END ---
# 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
#
# --- Installation & Usage ---
#
# $ git config --global commit.template <git-commit-template.txt>
#
# --- References ---
#
# * A useful template for commit messages: http://codeinthehole.com/writing/a-useful-template-for-commit-messages/
# * How to Write a Git Commit Message: http://chris.beams.io/posts/git-commit/
# * Example for a Good Commit Message: https://github.com/sparkbox/how_to/tree/master/style/git
#
# --------------------
# For more information about this template, check out
# https://gist.github.com/rpdelaney/41651befb2326a19aafec4660ff315e9
#
# vim: ft=gitcommit
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment