summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Dohmen <chris.dohmen@sciencelogic.com>2022-06-13 15:39:31 -0400
committerChris Dohmen <chris.dohmen@sciencelogic.com>2022-06-13 17:06:43 -0400
commit1eadf23b94846a0ebc8402e09190ed1de6dbffd0 (patch)
tree2c0c834d0884799ca443b047e254a09dffafec77
parent3793d87deb762f773eda1622ed87941c24bc253d (diff)
downloadpbr-1eadf23b94846a0ebc8402e09190ed1de6dbffd0.tar.gz
Specify Changelog procedure5.10.0
Update the CONTRIBUTING file to specify how release notes are managed. This allows contributors to follow best-practices to ensure the auto-generated Changelog stays up-to-date. Change-Id: I7902c33a76c4cce8f50307843476e5d9435c9e2c
-rw-r--r--CONTRIBUTING.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 33adff5..798ef48 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -9,6 +9,11 @@ the workflow documented at:
https://docs.opendev.org/opendev/infra-manual/latest/developers.html#development-workflow
+Release notes are managed through the tool
+`reno <https://pypi.org/project/reno/>`_. This tool will create
+a new file under the directory ``releasenotes`` that should
+be checked in with the code changes.
+
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub: