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
This commit is contained in:
Takashi Kajinami 2021-06-06 21:12:36 +09:00
parent ff0d66666b
commit 349b127227
1 changed files with 4 additions and 0 deletions

View File

@ -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 <https://docs.openstack.org/reno/latest/>`__ to maintain release notes.
Asking for review
=================