From fe49a399bd0c36353b2862ee116f73afa915ce2f Mon Sep 17 00:00:00 2001 From: Doug Latornell Date: Mon, 30 Dec 2024 14:04:04 -0800 Subject: [PATCH] Refine release notes structure in package dev docs Updated the release process instructions to include organizing auto-generated release notes into specific sections: Features, Bug Fixes, Documentation, Maintenance, and Dependency Updates. This change aims to improve clarity and consistency in release note presentation. --- docs/development.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/development.rst b/docs/development.rst index f1f1e41..a9dad81 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -579,7 +579,13 @@ The release process steps are: #. Push the version bump commit and tag to GitHub #. Use the GitHub web interface to create a release, - editing the auto-generated release notes as necessary + editing the auto-generated release notes into sections: + + * Features + * Bug Fixes + * Documentation + * Maintenance + * Dependency Updates #. Use the GitHub :guilabel:`Issues -> Milestones` web interface to edit the release milestone: