Changes between Version 19 and Version 20 of GitTips

Timestamp:

11/17/2016 12:07:36 AM (7 years ago)

Author:

Cas

Comment:

update git commit message details

GitTips

@@ -166 +166 @@
 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].
+Based on [http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines git commit guidelines] and [http://chris.beams.io/posts/git-commit/ How to Write a Git Commit Message].
+
+The short answer on the golden rule for git commit subject lines is to you ask yourself:
+  '''If applied, this commit will...''' ''<your commit subject line here>''[[br]][[br]]
+  e.g. If applied, this commit will {{{Enable editing of torrent names in Add Dialog}}}
+
+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 addressed 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.''
 
 Example commit message:
@@ -186 +199 @@
 }}}
 
-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 ===
-To differentiate commit changes at a glance, the subject of commits for specific components should be prefixed with relevant tags/labels, such as
-
-''Core'', ''WebUI'', ''GTKUI'', ''Tests'', ''win32'', ''Packaging'', ''Console'', ''Blocklist'' etc.
-
-{{{[GTKUI] Make Add Dialog torrent name editable}}}
+To differentiate commit changes at a glance, the subject of commits for specific components should be prefixed with relevant tags/labels, such as:
+ ''Core'', ''WebUI'', ''GTKUI'', ''Tests'', ''Packaging'', ''Console'', ''Blocklist'', ''Lint'' etc. (see git logs for more examples)
+
+{{{[GTKUI] Enable editing of torrent names in Add Dialog}}}
 
 If the commit fix/closes a ticket, include the number:
@@ -213 +213 @@
 {{{[#1002] [GTKUI] Fix the files tab context menu not being displayed}}}
 
-{{{[#2250] [Core] [GTKUI] Added method remove_torrents to core}}}
-
-
+{{{[#2250] [Core] [GTKUI] Add method remove_torrents to core}}}
+
+