From fe1dc6ea41b17372a489aa0cc8b7948192bfc54e Mon Sep 17 00:00:00 2001 From: Doug Latornell Date: Tue, 31 Dec 2024 16:14:18 -0800 Subject: [PATCH] Refine release notes structure in package dev docs (#320) 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/pkg_development.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/pkg_development.rst b/docs/pkg_development.rst index b3e3aaa2..66f4be17 100644 --- a/docs/pkg_development.rst +++ b/docs/pkg_development.rst @@ -741,7 +741,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: