openstack
/
shade
Code Issues Proposed changes

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
This commit is contained in:
David Shrewsbury 2016-05-04 09:54:26 -04:00
parent 31ac451e12
commit 04774d8f80
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/coding.rst
View File

@ -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 <http://docs.openstack.org/developer/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
===========