From 349b12722749625a47c6679e9e1bfbf37b7e34c4 Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Sun, 6 Jun 2021 21:12:36 +0900 Subject: [PATCH] Add a note about release note We encourage(and require) people to write a proper release note. Let's document it in our contributor guide as well. Change-Id: Ib89fcef30c985f11e36ea4225a0c2437e8b50ead --- doc/source/contributor/coding-style.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/source/contributor/coding-style.rst b/doc/source/contributor/coding-style.rst index 0b11267..5db5a25 100644 --- a/doc/source/contributor/coding-style.rst +++ b/doc/source/contributor/coding-style.rst @@ -107,6 +107,10 @@ Documentation - If possible, keep examples/\*.pp updated, they are very useful for our users. - Comment your code when needed (temporary workarounds, TODO, etc). +- Any change in interface (like new parameters, deprecations, and etc) or + fundamental behavior should be documented in a release note. In Puppet OpenStack, + we use `reno `__ to maintain release notes. + Asking for review =================