openstack/tempest
Code Issues Proposed changes

Add section on release notes to reviewing doc

Browse Source 
This commit adds a brief section about ensuring release notes are
present to the reviewing doc. This should hopefully make it more
clear to reviewers when we need to include release notes.

Change-Id: I0815b9c24f6ec9e384b1657c94ed387d0d748392
This commit is contained in:
Matthew Treinish 2016-06-22 10:32:45 -04:00
parent 26300f9bd3
commit b786dcae6c
No known key found for this signature in database
GPG Key ID: FD12A0F214C9E177
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
REVIEWING.rst
View File

@ -72,6 +72,19 @@ level docstring linking to the API ref doc in the API tests and a docstring for
scenario tests this is up to the reviewers discretion whether a docstring is scenario tests this is up to the reviewers discretion whether a docstring is
required or not. required or not.
Release Notes
-------------
Release notes are how we indicate to users and other consumers of Tempest what
has changed in a given release. Since Tempest 10.0.0 we've been using `reno`_
to manage and build the release notes. There are certain types of changes that
require release notes and we should not approve them without including a release
note. These include but aren't limited to, any addition, deprecation or removal
from the lib interface, any change to configuration options (including
deprecation), CLI additions or deprecations, major feature additions, and
anything backwards incompatible or would require a user to take note or do
something extra.
.. _reno: http://docs.openstack.org/developer/reno/
When to approve When to approve
--------------- ---------------