Another post (http://chris.beams.io/posts/git-commit/) resumes itself to
7 rules:
1. Separate subject from body with a blank line
2. Limit the subject line to 50 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 72 characters
7. Use the body to explain what and why vs. how
Rules 1-6 are common to both posts, but I think the 7th is the most
important: the "what" and "how" can be found in the diff, but never the
"why".
Another advice from this post on how to write the subject line:
> A properly formed git commit subject line should always be able
> to complete the following sentence:
>
> If applied, this commit will <your subject line here>
Le 23/09/2015 10:29, Colin Campbell a écrit :
Hi,
can I humbly suggest that we should take a couple of secs to make the
commit messages for submitted patches a bit more useful. When looking at
the history of the code its useful if the summary gives a brief
indication of what has been changed or added by the commit. Good
summaries can save a lot of frustrated time wasting when trying to track
down where a change has been introduced.
Although we flag up the bugzilla bug in the summary, just echoing the
bug summary is nearly always counter-productive. The commit should
indicate the change introduced not the bug that prompted it. Once the
patch is applied the original bug is "background reading" not the main
event. It is also misleading if the commit summary says "X is broken"
then when that is extracted into the release notes or the gitlog it
looks like the commit introduces the breakage of x not vice-versa. It is
surely better to have the commit say something along the lines of
"Fix broken behaviour in X", which makes it sound a bit more like the
desirable feature it no doubt is.
A long standing succinct post on commit messages is
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Colin
(Author of some of the world's worst commit messages)
--
Julian Maurice <[email protected]>
BibLibre
_______________________________________________
Koha-devel mailing list
[email protected]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
