From c95de2f171834ef5e5b76cd572d64fd92b1b8df6 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Tue, 28 Feb 2017 11:51:15 -0500 Subject: [PATCH] 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 --- doc/source/dev/faq.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/source/dev/faq.rst b/doc/source/dev/faq.rst index 4edc25f96..8d911cbb5 100644 --- a/doc/source/dev/faq.rst +++ b/doc/source/dev/faq.rst @@ -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`_.