doc: update FAQ for release notes
This updates the FAQ for release notes to: 1. clarify use of verb tense/person: e.g. 'adds' vs 'add' 2. indicate that variants of English spelling are acceptable Also move this note to the corrent FAQ item. Change-Id: I9571740c3d895d2a8aa50c354ccd71662e65d231
This commit is contained in:
parent
47d8717ca1
commit
c95de2f171
@ -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
|
intended to contain information for deployers, so changes to unit tests or
|
||||||
documentation are unlikely to require one.
|
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?
|
...create a new release note?
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
||||||
@ -63,7 +59,15 @@ By running ``reno`` command via tox, e.g::
|
|||||||
|
|
||||||
releasenotes/notes/version-foo-ecb3875dc1cbf6d9.yaml
|
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`_.
|
For more information see the `reno documentation`_.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user