From 07c53725abc74533f8e0dd1440cfdad42b844c38 Mon Sep 17 00:00:00 2001
From: rly <rly@lbl.gov>
Date: Mon, 16 Oct 2023 14:26:35 -0700
Subject: [PATCH] Add changelog and update next steps doc

---
 {{ cookiecutter.namespace }}/CHANGELOG.md | 1 +
 {{ cookiecutter.namespace }}/NEXTSTEPS.md | 4 ++++
 2 files changed, 5 insertions(+)
 create mode 100644 {{ cookiecutter.namespace }}/CHANGELOG.md

diff --git a/{{ cookiecutter.namespace }}/CHANGELOG.md b/{{ cookiecutter.namespace }}/CHANGELOG.md
new file mode 100644
index 0000000..942e2d3
--- /dev/null
+++ b/{{ cookiecutter.namespace }}/CHANGELOG.md	
@@ -0,0 +1 @@
+# Changelog for {{ cookiecutter.namespace }}
diff --git a/{{ cookiecutter.namespace }}/NEXTSTEPS.md b/{{ cookiecutter.namespace }}/NEXTSTEPS.md
index 654a17e..b92e465 100644
--- a/{{ cookiecutter.namespace }}/NEXTSTEPS.md	
+++ b/{{ cookiecutter.namespace }}/NEXTSTEPS.md	
@@ -44,6 +44,8 @@ replaced or removed.
 8. You may need to modify `pyproject.toml` and re-run `python -m pip install -e .` if you
 use any dependencies.
 
+9. Update the `CHANGELOG.md` regularly to document changes to your extension.
+
 
 ## Documenting and Publishing Your Extension to the Community
 
@@ -65,6 +67,8 @@ your extension.
 
 7. Add a license file. Permissive licenses should be used if possible. **A [BSD license](https://opensource.org/licenses/BSD-3-Clause) is recommended.**
 
+8. Update the `CHANGELOG.md` to document changes to your extension.
+
 8. Make a release for the extension on GitHub with the version number specified. e.g. if version is {{ cookiecutter.version }}, then this page should exist: https://github.com/{{ github_username_list[0] }}/{{ cookiecutter.namespace }}/releases/tag/{{ cookiecutter.version }} . For instructions on how to make a release on GitHub see [here](https://help.github.com/en/github/administering-a-repository/creating-releases).
 
 9. Publish your updated extension on [PyPI](https://pypi.org/).