From 6cfbc985019dd4b1b61f6d0b40963459daaf529b Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Thu, 24 Aug 2017 21:47:51 -0400 Subject: [PATCH] [doc] add FAQ about updating release notes 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 --- doc/source/contributor/faq.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/source/contributor/faq.rst b/doc/source/contributor/faq.rst index bc2d146f1a..da80c2778d 100644 --- a/doc/source/contributor/faq.rst +++ b/doc/source/contributor/faq.rst @@ -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 +`_.) + +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? -------------------------------