Skip to content

Commit

Permalink
Refine release notes structure in package dev docs (#97)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
douglatornell authored Dec 30, 2024
1 parent b3c1fd4 commit edf2cf3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit edf2cf3

Please sign in to comment.