Skip to content

Instantly share code, notes, and snippets.

@amingilani
Last active March 15, 2022 17:01
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save amingilani/20dec73fac7f8fd55e04d7a5d202847b to your computer and use it in GitHub Desktop.
Save amingilani/20dec73fac7f8fd55e04d7a5d202847b to your computer and use it in GitHub Desktop.
Git commit template
# Title: Summary, One-sentence headline description of change
# Start upper case, don't end with a period
# 50 chars max. This line is 50 chars long ######
# (Remember blank line between title and body.)
#
# Body: Explain *what* and *why* (not *how*).
#
# Add as many paragraphs as needed
#
# State the problem you're solving. This might be a description of
# a bug, or a quick overview of the new feature you're adding.
#
# Describe your changes. You can summarize what approach you
# took, what each part of the change is for, and why it works well.
#
# If applicable, explain any obvious alternative approaches you rejected.
# Add caveats of your approach
#
# Wrap at 72 chars. This line is 74 chars #############################
# Add the ticket URL:
Addresses https://COMPANY.atlassian.net/browse/XX-XXX
# At the end: Include Co-authored-by for all contributors.
# Include at least one empty line before it. Format:
#
# Co-authored-by: name <user@users.noreply.github.com>

Git Commit Message Template

To use:

  1. Save the template to ~/.gitmessage
  2. Run git config --global commit.template ~/.gitmessage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment