openstack
/
horizon
Code Issues Proposed changes

Improve release notes guidance - single patch 

After some discussion on a patch and in room with Doug,
we determined that we should make the guidance for release notes
more strongly suggest providing release notes in the same
patch as the changes being introduced.

Change-Id: Ifa8e8e9b01fafaa0a7e3e12b0052e4f8d5554e58
This commit is contained in:
Travis Tripp 2015-11-30 11:31:33 -07:00
parent d40391714a
commit 07fd6d83e2
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/contributing.rst
View File

@ -548,8 +548,11 @@ Simply by convention, we have a few rules about naming:
Release Notes
=============
The release notes for a patch should be included in the patch. If not, the
release notes should be in a follow-on review.
Release notes for a patch should be included in the patch with the
associated changes whenever possible. This allow for simpler tracking. It also
enables a single cherry pick to be done if the change is backported to a
previous release. In some cases, such as a feature that is provided via
multiple patches, release notes can be done in a follow-on review.
If the following applies to the patch, a release note is required: