openstack/ironic
Code Issues Proposed changes

[doc] add FAQ about updating release notes

Browse Source 
This adds a FAQ about how to update release notes; it makes a
difference as to whether the release note is on master, or whether
it is also on a stable branch. If it is on a stable branch, it is
only allowed in extenuating circumstances.

Change-Id: I49f3be17296795f90999171ab761f351a0a13c8c
This commit is contained in:
Ruby Loo 2017-08-24 21:47:51 -04:00
parent bb33d6ed49
commit 6cfbc98501
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/contributor/faq.rst
View File

@ -75,6 +75,26 @@ For more information see the `reno documentation`_.
.. _`reno documentation`: https://docs.openstack.org/reno/latest/user/usage.html
...update a release note?
-------------------------
If this is a release note that pertains to something that was fixed on master
and has not yet been released, you can go ahead and update it by submitting
a patch.
If it is the release note of an ironic release that has branched, it can be
updated but we will only allow it in extenuating circumstances. (It can be
updated by *only* updating the file in that branch. DO NOT update the file
in master and cherry-pick it. If you do, `see how the mess was cleaned up
<https://bugs.launchpad.net/ironic/+bug/1670401>`_.)
If it is the release note of an intermediary ironic release (during a
development cycle), you cannot update it. (These show up in the
"Current Series Release Notes"). If you do update it, it will show up under
the current (unreleased) section, instead of under the intermediary release
section, because the date/time of that file being touched is newer than the
date/time of the tag associated with the intermediary release.
...get a decision on something?
-------------------------------