Skip to content

Instantly share code, notes, and snippets.

@ludwig
Created July 25, 2018 21:02
Show Gist options
  • Save ludwig/f598d9cb3d43dabdf502170d125d2778 to your computer and use it in GitHub Desktop.
Save ludwig/f598d9cb3d43dabdf502170d125d2778 to your computer and use it in GitHub Desktop.
git commit template
# https://chris.beams.io/posts/git-commit/
# https://robots.thoughtbot.com/better-commit-messages-with-a-gitmessage-template
[commit]
template = ~/.gitmessage
# ... other configs
# -----------------------------------------------------------------------------
# Summarize changes in around 50 characters or less
#
# More detailed explanatory text, if necessary. Wrap it to about 72
# characters or so. In some contexts, the first line is treated as the
# subject of the commit and the rest of the text as the body. The
# blank line separating the summary from the body is critical (unless
# you omit the body entirely); various tools like `log`, `shortlog`
# and `rebase` can get confused if you run the two together.
#
# Explain the problem that this commit is solving. Focus on why you
# are making this change as opposed to how (the code explains that).
# Are there side effects or other unintuitive consequences of this
# change? Here's the place to explain them.
#
# Further paragraphs come after blank lines.
#
# - Bullet points are okay, too
#
# - Typically a hyphen or asterisk is used for the bullet, preceded
# by a single space, with blank lines in between, but conventions
# vary here
#
# If you use an issue tracker, put references to them at the bottom,
# like this:
#
# Resolves: #123
# See also: #456, #789
# -----------------------------------------------------------------------------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment