Skip to content

Commit

Permalink
rename whatsnew changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Aug 25, 2024
1 parent 068eaf3 commit 48b7349
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Follow this workflow:

1. go to your python environment for `pyprep`
1. make sure all tests pass and the docs are built cleanly
1. update `docs/whats_new.rst`, renaming the "current" headline to the new
1. update `docs/changelog.rst`, renaming the "current" headline to the new
version and updating the "Authors" section. "Authors" are all people
who committed code or in other ways contributed to `pyprep` (e.g., by
reviewing PRs, moderating discussions).
Expand All @@ -155,5 +155,5 @@ Follow this workflow:
Then the release is done and main has to be prepared for development of the
next release:

1. add a "current" headline to `docs/whats_new.rst`
1. add a "current" headline to `docs/changelog.rst`
1. commit the changes and `git push` to main (or make a pull request)
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
- [ ] the PR has been reviewed and all comments are resolved
- [ ] all [CI][what-is-ci] checks pass
- [ ] (if applicable): the PR description includes the phrase `closes #<issue-number>` to [automatically close an issue][auto-close-documentation]
- [ ] (if applicable): bug fixes, new features, or [API][what-is-api] changes are documented in [whats_new.rst][whats-new-file]
- [ ] (if applicable): new contributors have added themselves to the authors list in the `CITATION.cff` file
- [ ] (if applicable): the changes are documented in the changelog [changelog.rst][changelog]
- [ ] (if applicable): new contributors have added themselves to the authors list in the [`CITATION.cff`][citationcff] file


[what-is-ci]: https://help.github.com/en/actions/building-and-testing-code-with-continuous-integration/about-continuous-integration
[auto-close-documentation]: https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
[what-is-api]: https://en.wikipedia.org/wiki/Application_programming_interface
[whats-new-file]: https://github.com/sappelhoff/pyprep/blob/main/docs/whats_new.rst
[changelog]: https://github.com/sappelhoff/pyprep/blob/main/docs/changelog.rst
[citationcff]: https://github.com/sappelhoff/pyprep/blob/main/CITATION.cff
8 changes: 4 additions & 4 deletions docs/whats_new.rst → docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Authors
Please see the ``authors`` section in the ``CITATION.cff`` file for authors
who have contributed to this software across releases.

.. _whats_new:
.. _changelog:

What's New
==========
Changelog
=========

Here we list a changelog of ``pyprep``.
Here we list what's new in ``pyprep``.

.. contents:: Contents
:local:
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ PyPREP

Examples<examples>
API<api>
Changelog<whats_new>
Changelog<changelog>
Differences from PREP<matlab_differences>

0 comments on commit 48b7349

Please sign in to comment.