diff --git a/doc/dev/commit_convention.md b/doc/dev/commit_convention.md index 80362c175bec..9793350521a7 100644 --- a/doc/dev/commit_convention.md +++ b/doc/dev/commit_convention.md @@ -33,6 +33,9 @@ Format of the commit message - chore (maintain, ex: travis-ci) - perf (performance improvement, optimization, ...) +Every `feat` or `fix` commit must have a `changelog-*` label, and a commit message +beginning with "This PR " that will be included in the changelog. + ```` has the following constraints: - use imperative, present tense: "change" not "changed" nor "changes" @@ -44,6 +47,7 @@ Format of the commit message - just as in ````, use imperative, present tense - includes motivation for the change and contrasts with previous behavior + - If a `changelog-*` label is present, the body must begin with "This PR ". ``