Add to CONTRIBUTING.md

PolicyEngine · Sep 17, 2024 · ada4e73 · ada4e73
1 parent d66eae0
commit ada4e73
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,3 +1,7 @@
 ## Updating data
 
 If your changes present a non-bugfix change to one or more datasets which are cloud-hosted (FRS and EFRS), then please change both the filename and URL (in both the class definition file and in `storage/upload_completed_datasets.py`). This enables us to store historical versions of datasets separately and reproducibly.
+
+## Updating the versioning
+
+Please add to `changelog.yaml` and then run `make changelog` before committing the results ONCE in this PR.
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,6 +30,7 @@ dev = [
     "tables",
     "furo",
     "jupyter-book",
+    "yaml-changelog>=0.1.7",
 ]
 
 [tool.setuptools]