From b786dcae6c5e8e6e17838adebb7a98dc256c1464 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Wed, 22 Jun 2016 10:32:45 -0400 Subject: [PATCH] Add section on release notes to reviewing doc 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 --- REVIEWING.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/REVIEWING.rst b/REVIEWING.rst index bd6018d0db..676a2172a2 100644 --- a/REVIEWING.rst +++ b/REVIEWING.rst @@ -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 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 ---------------