diff options
| author | Michal Nasiadka <mnasiadka@gmail.com> | 2022-10-20 14:07:38 +0200 |
|---|---|---|
| committer | Michal Nasiadka <mnasiadka@gmail.com> | 2022-10-28 08:11:57 +0200 |
| commit | 397a9a33e86dbf235d9c888f237ce6377e4828de (patch) | |
| tree | efd19d82a24601708e1b0aed9967493bd0b07a23 /doc | |
| parent | 4a90585634c91ac78c8443b98578e8721db786f4 (diff) | |
| download | kolla-397a9a33e86dbf235d9c888f237ce6377e4828de.tar.gz kolla-397a9a33e86dbf235d9c888f237ce6377e4828de.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
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 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. |