diff --git a/CHANGES.rst b/CHANGES.rst index 00aedb6d..dba4824b 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -10,8 +10,9 @@ Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Thomas-Ch New features and enhancements ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Added French language support to the documentation. (:issue:`53`, :pull:`55`). -* Added a new set of functions to support creating and updating `pooch` registries, caching testing datasets from `hydrologie/xhydro-testdata`, and ensuring that testing datasets can be loaded into temporary directories. +* Added a new set of functions to support creating and updating `pooch` registries, caching testing datasets from `hydrologie/xhydro-testdata`, and ensuring that testing datasets can be loaded into temporary directories. (:pull:`62`). * `xhydro` is now configured to use `pooch` to download and cache testing datasets from `hydrologie/xhydro-testdata`. (:pull:`62`). +* `xhydro` is now `Semantic Versioning v2.0.0 `_ compliant. (:pull:`70`). Breaking changes ^^^^^^^^^^^^^^^^ @@ -24,6 +25,12 @@ Internal changes * `load_registry`: Loads installed (or custom) registry and returns dictionary * `populate_testing_data`: Fetches the registry and optionally caches files at a different location (helpful for `pytest-xdist`). * Added a `pre-commit` hook (`numpydoc`) to ensure that `numpy` docstrings are formatted correctly. (:pull:`62`). +* The cookiecutter has been updated to the latest commit (:pull:`70`): + * Added some workflows (Change file labelling, Cache cleaning, Dependency scans, `OpenSSF Scorecard `_). + * The README has been updated to organize badges in a table, including a badge for the OpenSSF Scorecard. + * Updated pre-commit hook versions to the latest available. + * Formatting tools are now pinned to their pre-commit equivalents. + * `actions-version-updater.yml` has been replaced by `dependabot `_. v0.3.0 (2023-12-01) ------------------- diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5f13ebe8..6707fb0d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -106,11 +106,11 @@ Ready to contribute? Here's how to set up ``xhydro`` for local development. # Or, to run multiple build tests $ tox - .. note:: + .. note:: - Running `pytest` or `tox` will automatically fetch and cache the testing data for the package to your local cache (using the `platformdirs` library). On Linux, this is located at ``XDG_CACHE_HOME`` (usually ``~/.cache``). On Windows, this is located at ``%LOCALAPPDATA%`` (usually ``C:\Users\username\AppData\Local``). On MacOS, this is located at ``~/Library/Caches``. + Running `pytest` or `tox` will automatically fetch and cache the testing data for the package to your local cache (using the `platformdirs` library). On Linux, this is located at ``XDG_CACHE_HOME`` (usually ``~/.cache``). On Windows, this is located at ``%LOCALAPPDATA%`` (usually ``C:\Users\username\AppData\Local``). On MacOS, this is located at ``~/Library/Caches``. - If for some reason you wish to cache this data elsewhere, you can set the ``XHYDRO_DATA_DIR`` environment variable to a different location before running the tests. For example, to cache the data in the current working directory, run:: + If for some reason you wish to cache this data elsewhere, you can set the ``XHYDRO_DATA_DIR`` environment variable to a different location before running the tests. For example, to cache the data in the current working directory, run:: $ export XHYDRO_DATA_DIR=$(pwd)/.cache