openstack/deb-ironic
Code Issues Proposed changes

Merge "doc: update FAQ for release notes"

Browse Source
This commit is contained in:
Jenkins 2017-03-02 23:07:45 +00:00 committed by Gerrit Code Review
commit f9ecaca12f
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -37,10 +37,6 @@ 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.
Note that we prefer to use present tense in release notes. For example, a
release note should say "Adds support for feature foo", not "Added support
for feature foo".
...create a new release note?
-----------------------------
@ -63,7 +59,15 @@ By running ``reno`` command via tox, e.g::
releasenotes/notes/version-foo-ecb3875dc1cbf6d9.yaml
Then edit the result file.
Then edit the result file. Note that:
- we prefer to use present tense in release notes. For example, a
release note should say "Adds support for feature foo", not "Added support
for feature foo". (We use 'adds' instead of 'add' because grammatically,
it is "ironic adds support", not "ironic add support".)
- any variant of English spelling (American, British, Canadian, Australian...)
is acceptable. The release note itself should be consistent and not have
different spelling variants of the same word.
For more information see the `reno documentation`_.