diff options
| -rw-r--r-- | doc/source/contributor/release-notes.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/source/contributor/release-notes.rst b/doc/source/contributor/release-notes.rst index e82da4c57..51cb61ec1 100644 --- a/doc/source/contributor/release-notes.rst +++ b/doc/source/contributor/release-notes.rst @@ -22,9 +22,12 @@ Kolla uses the following release notes sections: - ``prelude`` --- filled in by the PTL before each release or RC. Other release note types may be applied per common sense. -Each change should include a release note unless being a ``TrivialFix`` -change or affecting only docs or CI. Such changes should `not` include -a release note to avoid confusion. + +When a release note is required: + +- ``feature`` - best included with docs change (if separate from the code) +- ``user impacting`` - to improve visibility of the change for users + Remember release notes are mostly for end users which, in case of Kolla, are OpenStack administrators/operators. In case of doubt, the core team will let you know what is required. |