Update HACKING with how to generate release notes

Change-Id: Ie94d4518d6344f1e5bbfd9ddea0c7d8fba6018f2
2017-04-18 10:02:14 +00:00 · 2017-04-18 10:02:14 +00:00 · ddc9675d87
parent 4c83a3f7c3
commit ddc9675d87
1 changed files with 21 additions and 0 deletions
--- a/HACKING.rst
+++ b/HACKING.rst
@ -54,3 +54,24 @@ Agent Options
 - To list options available in freezer-agent use the following command::

    oslo-config-generator --namespace freezer --namespace oslo.log
+
+
+Release Notes
+-------------
+
+- When a new feature is commited we should have a new release notes page that
+ highlights the changes made. These release notes will be used for deployers,
+ users, and developers. There are a few steps that need to be taken in order.
+
+  * Generate a release notes page
+     1. tox -e venv -- reno new {my-new-feature}
+     2. http://docs.openstack.org/developer/reno/usage.html#creating-new-release-notes
+
+  * Update/Edit an existing release note
+     1. http://docs.openstack.org/developer/reno/usage.html#editing-a-release-note
+
+
+- Building release notes::
+
+    tox -e releasenotes
+