From 1eadf23b94846a0ebc8402e09190ed1de6dbffd0 Mon Sep 17 00:00:00 2001 From: Chris Dohmen Date: Mon, 13 Jun 2022 15:39:31 -0400 Subject: [PATCH] Specify Changelog procedure 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 --- CONTRIBUTING.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 33adff52..798ef48d 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 `_. 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: