Format of commit messages (#8365)
Co-authored-by: Patti Short <35278231+shortpatti@users.noreply.github.com>
Andrew Moss committed
Mar 12, 2020 at 09:05 UTC
f7e75546fb3a276e3fa9bf91d8e7d065ed177f4f
1 file changed
+7
CONTRIBUTING.md
+7
@@ -198,6 +198,13 @@ Improvements must have the title "[Area or module] : [Added/Refactored/Improved/
198
199
New collectors must have the title "[New collector] : [Name of collector]".
200
201
+#### Commit messages when PRs are merged
202
+
203
+When a PR gets squashed and merged into master, the title of the commit message (first line) must be the PR title
204
+followed by the PR number.
205
+
206
+The body of the commit message should be a short description of the work, preferably taken from the connected issue.
207
+
208
### PR approval process
209
210
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.