summaryrefslogtreecommitdiff
path: root/patchformatting.mdwn
diff options
context:
space:
mode:
authorPieter Praet <pieter@praet.org>2012-01-14 04:47:52 +0100
committerPieter Praet <pieter@praet.org>2012-01-14 05:31:28 +0100
commit8d3942dde2b3f4b84c27c36e6357e86b3f117c49 (patch)
tree0d812d9c9c8d787f7438fd291043a39ee7fc4533 /patchformatting.mdwn
parentd7c70a64d61ced5fca65ebf0cc998625994da538 (diff)
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/
Diffstat (limited to 'patchformatting.mdwn')
-rw-r--r--patchformatting.mdwn5
1 files changed, 5 insertions, 0 deletions
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