Browse code

CONTRIBUTING.md: section for first line of the commit message [skip ci]

- note about [skip ci] flag in first line

Daniel-Constantin Mierla authored on 04/03/2020 10:39:02
Showing 1 changed files
... ...
@@ -81,13 +81,20 @@ Please create the commit messages following the GIT convention:
81 81
   * start with one short line, preferably less then 50 chars summarizing the
82 82
   changes (this is referred later as "first line of the commit message")
83 83
   * then one empty line
84
-  * then a more detailed description
84
+  * then a more detailed description (the "commit message content")
85
+
86
+#### First Line Of The Commit Message ####
85 87
 
86 88
 Think of the first line as of an email "Subject" line. In fact it will be used
87 89
 as "Subject" in the generated commit emails and it will also be used when
88 90
 generating the Changelog (e.g. git log --pretty=oneline).
89 91
 
90
-Please start always with the prefix of the component (subsystem) that is modified by the commit, for example:
92
+
93
+The first line (subjecthas to contain meaningful text about what that commit
94
+does, do not put just a reference to bug tracker or pull request items
95
+
96
+Please start always with the prefix of the component (subsystem) that is modified
97
+by the commit, for example:
91 98
   * `core`: more fixup helper functions
92 99
     * `core`: tcp - support for haproxy protocol
93 100
     * `core`: mem - added faster malloc
... ...
@@ -96,13 +103,19 @@ Please start always with the prefix of the component (subsystem) that is modifie
96 103
   * `lib`: srutils - critical bug fix for abc case
97 104
   * `kamctl`: added support for management of module xyz
98 105
 
106
+At the end of the first line some CI flags can be added. Available at this
107
+moment:
108
+
109
+  * `[skip ci]` - skip continous integration builds for source code, recommended
110
+  to be added when updating documentation, example configs or other utilities.
111
+  Example:
112
+    * `msilo: docs - updated example for m_dump() function [skip ci]`
113
+
99 114
 #### Commit Message Content ####
100 115
 
101
-  * first line (subject line) has to contain meaningful text about what that commit
102
-  does, do not put just a reference to bug tracker or pull request items
103
-  * commit message must describe the changes done by the patch
116
+* commit message must describe the changes done by the patch
104 117
     * other details (e.g., how to reproduce, backtrace, sip packets, ...) belong
105
-    to content (comments) of the pull request. Example:
118
+    to content (comments) of the pull request. Example of a full commit message:
106 119
 ```
107 120
 core: added latency_limit_cfg global parameter
108 121