Changes between Version 18 and Version 19 of Contributing/CodingStyle

Timestamp:

09/14/2015 01:13:44 PM (9 years ago)

Author:

bro

Comment:

More on how to write commit message

Contributing/CodingStyle

@@ -63 +63 @@
 This should probably have it's own page but putting here for now.
 }}}
-Mainly based on [http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines git commit guidelines]. Example commit message:
+Mainly based on [http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines git commit guidelines].
+
+Example commit message:
 
 {{{
@@ -80 +82 @@
     single space, with blank lines in between, but conventions vary here
 }}}
+
+A general guideline on writing a good commit message is to provide information
+that is not already provided from the commit diff, which in essence is "''the why, not the how''".
+
+ * Explain why the change is necessary
+
+ After reading the commit message it should should be apparent why the changes were made.
+
+ * Explain how the issue is adressed in broad terms
+
+ It is not necessary to explain how the changes are made in detail as that can be seen from the commit diff.
+
 
 === Tags / Labels ===