[FAB-6195] Update one-line description of commit msg

This CR updates the documentation to include the Jira issue ID in the online commit message for readability. It also states that issue IDs in commit messages will be automatically linked to the corresponding entry in Jira. Change-Id: Ic5a79137db10f1ba6fcc434e0632a9448e2cffd9 Signed-off-by: Dileban Karunamoorthy <[email protected]> [FAB-6195] Use [FAB-XXXX] in commit message example The convention right now is to specify the Jira issue ID with square brackets. Change-Id: Ic5a79137db10f1ba6fcc434e0632a9448e2cffd9 Signed-off-by: Dileban Karunamoorthy <[email protected]> [FAB-6195] Fix typo in description following example A silly typo, should be 'of' instead of 'if' Change-Id: Ic5a79137db10f1ba6fcc434e0632a9448e2cffd9 Signed-off-by: Dileban Karunamoorthy <[email protected]>
hyperledger · Sep 22, 2017 · d620808 · d620808
1 parent fe5b068
commit d620808
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/docs/source/Gerrit/changes.rst b/docs/source/Gerrit/changes.rst
@@ -42,17 +42,19 @@ commit file is illustrated below in detail:
 
 ::
 
-    A short description of your change with no period at the end
+    [FAB-XXXX] A short description of your change with no period at the end
 
     You can add more details here in several paragraphs, but please keep each line
     width less than 80 characters. A bug fix should include the issue number.
 
-    Fix Issue # 7050.
-
     Change-Id: IF7b6ac513b2eca5f2bab9728ebd8b7e504d3cebe1
     Signed-off-by: Your Name <[email protected]>
 
-Each commit must contain the following line at the bottom of the commit
+Include the issue ID in the one line description of your commit message for
+readability. Gerrit will link issue IDs automatically to the corresponding
+entry in Jira.
+
+Each commit must also contain the following line at the bottom of the commit
 message:
 
 ::