From 2662e1fbbb1a72eaaaa98c43202d421667a2ccf4 Mon Sep 17 00:00:00 2001 From: Jim Rollenhagen Date: Wed, 21 Sep 2016 09:29:18 -0400 Subject: [PATCH] Add tense guide to release note FAQ Use present tense, since that's what we've been trying to do in recent times. Change-Id: Icf1d1c9a8e8cdd31bdd3c77425c9d0d8259fd59d --- doc/source/dev/faq.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/source/dev/faq.rst b/doc/source/dev/faq.rst index 92f66de54b..df74e409c4 100644 --- a/doc/source/dev/faq.rst +++ b/doc/source/dev/faq.rst @@ -36,6 +36,10 @@ 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? -----------------------------