Gentoo Archives: gentoo-portage-dev

From: Brian Dolbec <dolsen@g.o>
To: gentoo-portage-dev@l.g.o
Subject: Re: [gentoo-portage-dev] [PATCH 3/3] DEVELOPING: Add note on commit messages
Date: Thu, 27 Mar 2014 19:47:03
Message-Id: 20140327124640.1b2b35fe.dolsen@gentoo.org
In Reply to: [gentoo-portage-dev] [PATCH 3/3] DEVELOPING: Add note on commit messages by Alexander Berntsen
1 On Thu, 27 Mar 2014 13:48:40 +0100
2 Alexander Berntsen <bernalex@g.o> wrote:
3
4 > ---
5 > DEVELOPING | 20 ++++++++++++++++++++
6 > 1 file changed, 20 insertions(+)
7 >
8 > diff --git a/DEVELOPING b/DEVELOPING
9 > index c6004ec..a34dda5 100644
10 > --- a/DEVELOPING
11 > +++ b/DEVELOPING
12 > @@ -175,6 +175,26 @@ change a lot of unrelated things. This makes it
13 > easier to see what parts of the system have actually changed. It
14 > also makes it easier to cherry-pick and revert commits. Use your
15 > commonsense!
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
21 > explanatory +text. The headline should be capped at 50 characters,
22 > the detailed text +at 72. Prefix the message with the component you
23 > touched if this makes +sense. Postfix the message with the bug it
24 > fixes, if it does. Example: +
25 > +"
26 > +emerge: Fix --tree output (#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 No, Willikins works with Bug 555555, not #555555.
41
42 so stick with (bug 555555) format
43
44 or if your worried about the space since bug is 2 char. longer than #,
45 drop the 2 () characters. It'll be the same length so:
46
47 +emerge: Fix --tree output bug 555555
48
49
50 --
51 Brian Dolbec <dolsen>

Replies

Subject Author
[gentoo-portage-dev] [PATCH] DEVELOPING: Add note on commit messages Alexander Berntsen <bernalex@g.o>