Gentoo Archives: gentoo-portage-dev

From: Alexander Berntsen <bernalex@g.o>
To: gentoo-portage-dev@l.g.o
Subject: [gentoo-portage-dev] [PATCH 3/3] DEVELOPING: Add note on commit messages
Date: Thu, 27 Mar 2014 12:49:31
Message-Id: 1395924520-9291-4-git-send-email-bernalex@gentoo.org
In Reply to: [gentoo-portage-dev] [PATCH 0/3] Let's standardise commit messages by Alexander Berntsen
1 ---
2 DEVELOPING | 20 ++++++++++++++++++++
3 1 file changed, 20 insertions(+)
4
5 diff --git a/DEVELOPING b/DEVELOPING
6 index c6004ec..a34dda5 100644
7 --- a/DEVELOPING
8 +++ b/DEVELOPING
9 @@ -175,6 +175,26 @@ change a lot of unrelated things. This makes it easier to see what
10 parts of the system have actually changed. It also makes it easier to
11 cherry-pick and revert commits. Use your commonsense!
12
13 +Commit messages
14 +---------------
15 +
16 +Commit messages should be in the imperative mood with a capitalised
17 +header, optionally followed by a newline and a more detailed explanatory
18 +text. The headline should be capped at 50 characters, the detailed text
19 +at 72. Prefix the message with the component you touched if this makes
20 +sense. Postfix the message with the bug it fixes, if it does. Example:
21 +
22 +"
23 +emerge: Fix --tree output (#555555)
24 +
25 +Make sure newlines appear where they are supposed to. Fix a bug with
26 +colourisation of --tree output when used in tandem with --verbose
27 +--pretend --ask.
28 +"
29 +
30 +For a more detailed explanation (and rationalisation) of these rules:
31 +<http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html>
32 +
33 Releases
34 --------
35
36 --
37 1.8.3.2

Replies