docs: Added PR title guidelines to the contribution guidelines, to make CHANGELOG more meaningful (#8150)
* Added PR title guidelines * Add "Optimized" to verbs for improvements
Chris Akritidis committed
Feb 24, 2020 at 12:41 UTC
412df53dd22bea876ff424df42490f4ee587bced
1 file changed
+10
CONTRIBUTING.md
+10
@@ -181,6 +181,16 @@ However, it's not always that simple. Our [PR approval process](#pr-approval-pro
181
182
One thing you will need to do only for your first pull request in Netdata is to accept the CLA. Until you do, the automated check for the CLA acceptance will be showing as failed.
183
184
+#### PR title guidelines
185
+
186
+All verbs in PR titles must be in the past tense. E.g. "Added" instead of "Adds", "Fixed" instead of "Fixes".
187
+
188
+Bug fixes must have the title "Fixed [description of the problem as a user would perceive it], by [explanation of the correction]".
189
+
190
+Improvements must have the title "[Area or module] : [Added/Refactored/Improved/Corrected/Started to/Stopped/Modified/Optimized] [x], [in order to/so that] [benefit]". The second part may be left out, if the benefit is obvious from the improvement "x".
191
+
192
+New collectors must have the title "[New collector] : [Name of collector]".
193
+
194
### PR approval process
195
196
Each PR automatically [requires a review](https://help.github.com/articles/about-required-reviews-for-pull-requests/) from the code owners specified in `.github/CODEOWNERS`. Depending on the files contained in your PR, several people may be need to approve it.