Skip to content

Commit

Permalink
Update CONTRIBUTING.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
RondeauG authored Oct 12, 2023
1 parent 719bc64 commit 6a2d3a5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ $ git push
4. Once the pull request is merged, create a new release on GitHub. Both the tag and the release title should be the version number, prefixed with a `v` (e.g. `v0.2.0`).
5. To generate the release notes, run::

$ import xhydro
$ print(xhydro.utils.publish_release_notes())
$ import xhydro.testing.utils as xhu
$ print(xhu.publish_release_notes())

This will print the release notes (taken from the `HISTORY.rst` file) to your python console. Copy and paste them into the GitHub release description, keeping only the changes for the current version.

Expand Down

0 comments on commit 6a2d3a5

Please sign in to comment.