From 04774d8f805047ea61be878c1c0a85d0f059cd99 Mon Sep 17 00:00:00 2001 From: David Shrewsbury Date: Wed, 4 May 2016 09:54:26 -0400 Subject: [PATCH] Add release note doc to dev guide Add a section to our Coding Standards documentation that describes the use of reno for shade release notes. Change-Id: I87973c5b3f68727aa0cb1ccb9a82c90a8a32ebd1 --- doc/source/coding.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/source/coding.rst b/doc/source/coding.rst index 40a49e7c9..eca626440 100644 --- a/doc/source/coding.rst +++ b/doc/source/coding.rst @@ -15,6 +15,20 @@ Some of it just hasn't been changed yet. But be clear, all new code Below are the patterns that we expect Shade developers to follow. +Release Notes +============= + +Shade uses `reno `_ for +managing its release notes. A new release note should be added to +your contribution anytime you add new API calls, fix significant bugs, +add new functionality or parameters to existing API calls, or make any +other significant changes to the code base that we should draw attention +to for the user base. + +It is *not* necessary to add release notes for minor fixes, such as +correction of documentation typos, minor code cleanup or reorganization, +or any other change that a user would not notice through normal usage. + API Methods ===========