[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[newdak/master] Suggest that an email-like formatting of commit messages is used.



This is used extensively in the Git world, and in my experience,
it's very useful to have concise summary lines explaining the change.
(In my experience they are also hard to write sometimes, but I
think they pay off.)

Signed-off-by: Adeodato Simó <dato@net.com.org.es>
Signed-off-by: Joerg Jaspert <joerg@debian.org>
---
 CodingStyle.txt |   12 +++++++++++-
 1 files changed, 11 insertions(+), 1 deletions(-)

diff --git a/CodingStyle.txt b/CodingStyle.txt
index ccd4f45..2acf6f6 100644
--- a/CodingStyle.txt
+++ b/CodingStyle.txt
@@ -35,4 +35,14 @@ VCS related:
   the main code - merge it over to master (which ideally is a
   fastforward) and push it up.
 
-- Write good, meaningful, commit messages!
+- Write good, meaningful, commit messages. Also, try to use the standard
+  format used in the Git world:
+
+    First comes a summary line, of around 72 caracters at most.
+
+    Then, a blank line, and as many lines and paragraphs as needed
+    to describe the change in detail. Beware, though, of including
+    in the commit message explanations that would be better to have
+    as comments in the code itself!
+
+    Signed-off-by: Your Name <and@address.com>
-- 
1.5.6.3


Reply to: