Gentoo Archives: gentoo-portage-dev

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