diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index d4c748550..d2aa993dd 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,7 +5,7 @@
- This PR fixes #xyz
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] (If applicable) Documentation has been added / updated (for bug fixes / features)
-- [ ] CHANGES.rst has been updated (with summary of main changes)
+- [ ] CHANGELOG.rst has been updated (with summary of main changes)
- [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`) has been added
### What kind of change does this PR introduce?
diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml
index eff2cd770..c58735b8b 100644
--- a/.github/workflows/bump-version.yml
+++ b/.github/workflows/bump-version.yml
@@ -8,7 +8,7 @@ on:
- .*
- .github/*/*.md
- .github/*/*.yml
- - CHANGES.rst
+ - CHANGELOG.rst
- CI/*.txt
- Makefile
- docs/*/*.ipynb
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
index ee587ccb4..73751d8e5 100644
--- a/.github/workflows/codeql.yml
+++ b/.github/workflows/codeql.yml
@@ -5,7 +5,7 @@ on:
branches:
- main
paths-ignore:
- - CHANGES.rst
+ - CHANGELOG.rst
- CI/*.txt
- Makefile
- pyproject.toml
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 8ab44d47a..c3db33531 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -5,7 +5,7 @@ on:
branches:
- main
paths-ignore:
- - CHANGES.rst
+ - CHANGELOG.rst
- README.rst
- pyproject.toml
- xclim/__init__.py
diff --git a/.github/workflows/upstream.yml b/.github/workflows/upstream.yml
index 5c5f265d5..a472e854d 100644
--- a/.github/workflows/upstream.yml
+++ b/.github/workflows/upstream.yml
@@ -4,7 +4,7 @@ on:
branches:
- main
paths-ignore:
- - CHANGES.rst
+ - CHANGELOG.rst
- README.rst
- pyproject.toml
- xclim/__init__.py
diff --git a/CHANGES.rst b/CHANGELOG.rst
similarity index 99%
rename from CHANGES.rst
rename to CHANGELOG.rst
index cb7c9db91..7ad4c768e 100644
--- a/CHANGES.rst
+++ b/CHANGELOG.rst
@@ -6,10 +6,6 @@ v0.51.0 (unreleased)
--------------------
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Pascal Bourgault (:user:`aulemahal`).
-Bug fixes
-^^^^^^^^^
-* Units of degree-days computations with Fahrenheit input fixed to yield "°R d". Added a new ``xclim.core.units.ensure_absolute_temperature`` method to convert from delta to absolute temperatures. (:issue:`1789`, :pull:`1804`).
-
New features and enhancements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* Added the `op` keyword to the `growing_season_{start|end}` indices and indicators, allowing for customizable threshold operators using `indices.generic.compare()`. (:issue:`1794`, :pull:`1796`).
@@ -17,6 +13,7 @@ New features and enhancements
Bug fixes
^^^^^^^^^
+* Units of degree-days computations with Fahrenheit input fixed to yield "°R d". Added a new ``xclim.core.units.ensure_absolute_temperature`` method to convert from delta to absolute temperatures. (:issue:`1789`, :pull:`1804`).
* Clarified a typo in the docstring formula for `xclim.indices.growing_season_length`. (:pull:`1796`).
Internal changes
@@ -24,6 +21,7 @@ Internal changes
* `netcdf4` has been pinned below v1.7 for test stability reasons. (:pull:`1791`).
* `flake8-bandit`-like checks have been enabled via `ruff`, with fixes for a few security-related issues. (:pull:`1806`).
* ``xclim.testing.utils`` now employs more secure URL auditing checks. (:pull:`1806`).
+* `CHANGES.rst` has been renamed to `CHANGELOG.rst`, adhering to suggestions from the `keepachangelog v.1.1.0 `_ specifications. (:pull:`1823`).
CI changes
^^^^^^^^^^
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index a992e60cb..8ee31bc0e 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -253,7 +253,7 @@ Before you submit a pull request, please follow these guidelines:
Ensure that your changes pass all tests prior to pushing your final commits to your branch.
Code formatting errors are treated as build errors and will block your pull request from being accepted.
-#. The version changes (CHANGES.rst) should briefly describe changes introduced in the Pull request. Changes should be organized by type (ie: `New indicators`, `New features and enhancements`, `Breaking changes`, `Bug fixes`, `Internal changes`) and the GitHub Pull Request, GitHub Issue. Your name and/or GitHub handle should also be listed among the contributors to this version. This can be done as follows::
+#. The version changes (CHANGELOG.rst) should briefly describe changes introduced in the Pull request. Changes should be organized by type (ie: `New indicators`, `New features and enhancements`, `Breaking changes`, `Bug fixes`, `Internal changes`) and the GitHub Pull Request, GitHub Issue. Your name and/or GitHub handle should also be listed among the contributors to this version. This can be done as follows::
Contributors to this version: John Jacob Jingleheimer Schmidt (:user:`username`).
@@ -367,7 +367,7 @@ This section serves as a reminder for the maintainers on how to prepare the libr
When a new version has been minted (features have been successfully integrated test coverage and stability is adequate), maintainers should update the pip-installable package (wheel and source release) on PyPI as well as the binary on conda-forge.
-From a new branch (e.g. `prepare-v123`), open a Pull Request and make sure all your changes to support a new version are committed (**update the entry for newest version in CHANGES.rst**), Then run::
+From a new branch (e.g. `prepare-v123`), open a Pull Request and make sure all your changes to support a new version are committed (**update the entry for newest version in CHANGELOG.rst**), Then run::
$ bump-my-version bump