From ad5edc6a664399b1e776d9d6579c6c63030b42eb Mon Sep 17 00:00:00 2001 From: David Huggins-Daines Date: Thu, 12 Dec 2024 07:44:50 -0500 Subject: [PATCH] docs: add note about changelog --- CHANGELOG.md | 2 ++ README.md | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9f929c0429..7809b67d71 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ ### Fixes +- **Remind contributors to update the changelog**. CI fails if you don't add an entry to `CHANGELOG.md` but this is not mentioned in the development documentation. + ## 0.16.11 ### Enhancements diff --git a/README.md b/README.md index e9389b9cc8..0c992b3892 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,10 @@ If using the optional `pre-commit`, you'll just need to install the hooks with ` `pre-commit` package is installed as part of `make install` mentioned above. Finally, if you decided to use `pre-commit` you can also uninstall the hooks with `pre-commit uninstall`. +When submitting a pull request, make sure to add an entry to +[`CHANGELOG.md`](./CHANGELOG.md) (under the development version at the +top of the file) describing the changes. + In addition to develop in your local OS we also provide a helper to use docker providing a development environment: ```bash