From: Pieter Praet <pieter@praet.org>
Date: Sat, 14 Jan 2012 03:47:52 +0000 (+0100)
Subject: patchformatting.mdwn: added cworth's statement re commit msg body
X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=commitdiff_plain;h=8d3942dde2b3f4b84c27c36e6357e86b3f117c49

patchformatting.mdwn: added cworth's statement re commit msg body

I'd love to have used ikiwiki's shortcut directive [1] 'gmanemsg'
(which is enabled @ notmuchmail.org [2])

  eg. [[has stated|!gmanemsg 87ocmwok2w.fsf@yoom.home.cworth.org]]

but this isn't possible yet [3], so I had to insert the actual link...

[1] http://notmuchmail.org/shortcuts/
[1] http://ikiwiki.info/shortcuts/
[2] http://ikiwiki.info/todo/shortcut_with_different_link_text/
---

diff --git a/patchformatting.mdwn b/patchformatting.mdwn
index 3a122fc..8f32031 100644
--- a/patchformatting.mdwn
+++ b/patchformatting.mdwn
@@ -33,6 +33,11 @@ Enter your commit message in following format:
 The 65-character (limit) seems to be common among many projects so
 that is good guideline to follow here too.
 
+Regarding the commit message body contents, Carl [has stated](http://article.gmane.org/gmane.mail.notmuch.general/504):
+
+> The single line summary is good about saying *what* the commit does,
+> but I always want to see at least one sentence about the *why* as well.
+
 ### Activating default pre-commit hook
 
 Git provides a default pre-commit hook which, when activated, checks