Skip to content

Commit 68fc2d5

Browse files
committed
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.
1 parent 2c29b99 commit 68fc2d5

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/pkg_development.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -741,7 +741,13 @@ The release process steps are:
741741
#. Push the version bump commit and tag to GitHub
742742

743743
#. Use the GitHub web interface to create a release,
744-
editing the auto-generated release notes as necessary
744+
editing the auto-generated release notes into sections:
745+
746+
* Features
747+
* Bug Fixes
748+
* Documentation
749+
* Maintenance
750+
* Dependency Updates
745751

746752
#. Use the GitHub :guilabel:`Issues -> Milestones` web interface to edit the release
747753
milestone:

0 commit comments

Comments
 (0)