openstack/ironic
Code Issues Proposed changes

Clarify what changes need a release note

Browse Source 
This information is added to developer's FAQ.

Change-Id: Id615ee9ff50e6f8d7279c07ba31c5d9d31e399ef
This commit is contained in:
Vladyslav Drok 2015-12-08 12:14:21 +02:00
parent 103e211d35
commit 10fdbcd8c4
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/dev/faq.rst
View File

@ -27,6 +27,15 @@ For more information see the `alembic documentation`_.
.. _`alembic documentation`: https://alembic.readthedocs.org/en/latest/tutorial.html#create-a-migration-script .. _`alembic documentation`: https://alembic.readthedocs.org/en/latest/tutorial.html#create-a-migration-script
...know if a release note is needed for my change?
--------------------------------------------------
`Reno documentation`_ contains a description of what can be added to each
section of a release note. If, after reading this, you're still unsure about
whether to add a release note for your change or not, keep in mind that it is
intended to contain information for deployers, so changes to unit tests or
documentation are unlikely to require one.
...create a new release note? ...create a new release note?
----------------------------- -----------------------------
@ -53,4 +62,4 @@ Then edit the result file.
For more information see the `reno documentation`_. For more information see the `reno documentation`_.
.. _`reno documentation`: http://docs.openstack.org/developer/reno/usage.html#creating-new-release-notes .. _`reno documentation`: http://docs.openstack.org/developer/reno/usage.html