diff options
| author | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2020-02-24 12:41:41 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-24 12:41:41 -0800 |
| commit | 412df53dd22bea876ff424df42490f4ee587bced (patch) | |
| tree | aaafdbf47758b14cc8ce3039802fc5aab464d63c /CONTRIBUTING.md | |
| parent | 48229898d362d5de316a651dc2f132ac578fbeb6 (diff) | |
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
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35e45632b9..d24bd684df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -181,6 +181,16 @@ However, it's not always that simple. Our [PR approval process](#pr-approval-pro 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. +#### PR title guidelines + +All verbs in PR titles must be in the past tense. E.g. "Added" instead of "Adds", "Fixed" instead of "Fixes". + +Bug fixes must have the title "Fixed [description of the problem as a user would perceive it], by [explanation of the correction]". + +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". + +New collectors must have the title "[New collector] : [Name of collector]". + ### PR approval process 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. |