diff options
| author | Zuul <zuul@review.opendev.org> | 2022-11-09 06:48:56 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2022-11-09 06:48:56 +0000 |
| commit | 9b5d41df920014dd43dabe491e60d39445e8ba01 (patch) | |
| tree | 00c6ee54e1fb23dfb3390c150d19ce6d3fc094b1 | |
| parent | e275875c2587696025cb6dd5851cb42b010c56ed (diff) | |
| parent | 397a9a33e86dbf235d9c888f237ce6377e4828de (diff) | |
| download | kolla-9b5d41df920014dd43dabe491e60d39445e8ba01.tar.gz kolla-9b5d41df920014dd43dabe491e60d39445e8ba01.zip | |
Merge "docs: when reno is required"
| -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. |