diff options
| author | Michal Nasiadka <mnasiadka@gmail.com> | 2022-10-20 14:07:38 +0200 |
|---|---|---|
| committer | Michal Nasiadka <mnasiadka@gmail.com> | 2025-11-28 12:40:22 +0100 |
| commit | a65b87e9b656c9eac2bbd938d248cec91289bed6 (patch) | |
| tree | 938d0c817796ddef96a88f7ea1ac3f6a3f327147 /doc | |
| parent | 3bd221a98819d271f3629b6a95f16da89b1ba303 (diff) | |
| download | kolla-ansible-a65b87e9b656c9eac2bbd938d248cec91289bed6.tar.gz kolla-ansible-a65b87e9b656c9eac2bbd938d248cec91289bed6.zip | |
docs: when reno is required
In Zed PTG we decided to limit the amount of release notes
this change adds the criteria when reno is required to the docs
[1]: https://etherpad.opendev.org/p/kolla-zed-ptg#L149
Change-Id: I4f153a619eb57a75ebdb1aba4b71e422b30d74fe
Signed-off-by: Michal Nasiadka <mnasiadka@gmail.com>
Diffstat (limited to 'doc')
| -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 5c783b9b8..766c64a39 100644 --- a/doc/source/contributor/release-notes.rst +++ b/doc/source/contributor/release-notes.rst @@ -22,9 +22,12 @@ Kolla Ansible (just like 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. |