docs: add note about changelog

Unstructured-IO · Dec 12, 2024 · ad5edc6 · ad5edc6
1 parent 3b718ec
commit ad5edc6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -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