Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Add a commit message template

Using the `commit.template` setting, read in a commit message template
for each commit. This template is commented out so the commit message
author doesn't need to delete it.

The template serves as a reminder on how to write a better commit
message. The bullets are taken from Caleb's blog post[1]. There is no
_problem_ per se -- we are writing good messages these days -- but it's
handy to be reminded of things to think about. For example, people often
forget to note whether there are any side effects.

This message does not show on `git commit --amend`, only normal `git

  • Loading branch information...
commit 11a5504dfef7e79ffcdda77f042fac157125e3db 1 parent 82acdf7
@mike-burns mike-burns authored
Showing with 13 additions and 0 deletions.
  1. +2 −0  gitconfig
  2. +11 −0 gitmessage
2  gitconfig
@@ -21,3 +21,5 @@
ff = only
path = .gitconfig.local
+ template = ~/.gitmessage
11 gitmessage
@@ -0,0 +1,11 @@
+# 50-character subject line
+# 72-character wrapped longer description. This should answer:
+# * Why was this change necessary?
+# * How does it address the problem?
+# * Are there any side effects?
+# Include a link to the ticket, if any.

0 comments on commit 11a5504

Please sign in to comment.
Something went wrong with that request. Please try again.