diff options
| author | Andrew Moss <1043609+amoss@users.noreply.github.com> | 2020-03-12 09:05:44 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-12 09:05:44 +0100 |
| commit | f7e75546fb3a276e3fa9bf91d8e7d065ed177f4f (patch) | |
| tree | ef2225ec856c977538236790daed59f6d62e611d /CONTRIBUTING.md | |
| parent | 6ac0ea6fe66d5cf932237265861194a06027d1a5 (diff) | |
Format of commit messages (#8365)
Co-authored-by: Patti Short <35278231+shortpatti@users.noreply.github.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f99fd21a6..41827a5d2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -198,6 +198,13 @@ Improvements must have the title "[Area or module] : [Added/Refactored/Improved/ New collectors must have the title "[New collector] : [Name of collector]". +#### Commit messages when PRs are merged + +When a PR gets squashed and merged into master, the title of the commit message (first line) must be the PR title +followed by the PR number. + +The body of the commit message should be a short description of the work, preferably taken from the connected issue. + ### 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. |