[nemiver] Update the commit log guidelines
- From: Dodji Seketeli <dodji src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nemiver] Update the commit log guidelines
- Date: Wed, 23 Mar 2011 20:39:31 +0000 (UTC)
commit 1a2f5ea524718ad0ef4b330ce660f78a394869b5
Author: Dodji Seketeli <dodji seketeli org>
Date: Wed Mar 23 21:14:21 2011 +0100
Update the commit log guidelines
git-commit-messages.README | 13 ++++++++-----
1 files changed, 8 insertions(+), 5 deletions(-)
---
diff --git a/git-commit-messages.README b/git-commit-messages.README
index 39b6af4..0779f9c 100644
--- a/git-commit-messages.README
+++ b/git-commit-messages.README
@@ -3,14 +3,17 @@ Git commit messages format
The first line of a git commit message should start at column 1, with no
space. That line should be a short summary of the purpose of the commit.
-If the commit relates to a bug filed into bugzilla, the line should end with
-'(Closes: #<number-of-the-bug>)', without the quotes.
-The line in its entirety should not be longer than 80 characters.
+If the commit relates to a bug filed into bugzilla, the line should
+begin with the bug number, followed by a white space; e.g:
+
+#<number-of-the-bug> This is a great commit
+
+The line in its entirety should not be longer than 50 characters.
The next line should be an empty line, with no spaces.
The subsequent lines should have the form of the Body of a GNU ChangeLog
-entry i.e,
+entry, i.e:
* file1.c (func1): Changed foo in this function.
(func2): Changed blah in that function
* file2.c (func_foo): Changed something here.
@@ -21,7 +24,7 @@ Also note that right after the '*', there is a space.
An exemple of commit message would be:
~=~
-Shorten compilation lines (Closes: #123456)
+123456 Shorten compilation lines
* configure.ac: Shorten compilation lines by regrouping
PKG_CHECK_MODULES calls.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]