openstack/horizon
Code Issues Proposed changes

Merge "Add some notices on handling release notes"

Browse Source
This commit is contained in:
Jenkins 2017-08-06 14:20:13 +00:00 committed by Gerrit Code Review
commit 50354f0248
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/contributor/contributing.rst
View File

@ -613,6 +613,16 @@ If the following applies to the patch, a release note is required:
* It is not recommended that individual release notes use **prelude**
section as it is for release highlights.
.. warning::
Avoid modifying an existing release note file even though it is related to
your change. If you modify a release note file of a past release, the whole
content will be shown in a latest release. The only allowed case is to
update a release note in a same release.
If you need to update a release note of a past release, edit a corresponding
release note file in a stable branch directly.
Horizon uses `reno <https://docs.openstack.org/reno/latest/user/usage.html>`_ to
generate release notes. Please read the docs for details. In summary, use

5
releasenotes/source/index.rst
View File

@ -17,3 +17,8 @@
grizzly
folsom
essex
.. toctree::
:maxdepth: 1
Release Notes Howto <https://docs.openstack.org/horizon/latest/contributor/contributing.html#release-notes>