From db260ecfa321a76a1c9348e6f6bb931e6c31060b Mon Sep 17 00:00:00 2001
From: Xevion <xevion@xevion.dev>
Date: Sat, 9 Nov 2024 12:47:07 -0600
Subject: [PATCH] Add RELEASE_CHECKLIST.md

---
 CHANGELOG.md         | 1 +
 RELEASE_CHECKLIST.md | 8 ++++++++
 2 files changed, 9 insertions(+)
 create mode 100644 RELEASE_CHECKLIST.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1ea60ee..7fbd842 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Added
 
+- A release checklist to the `CHANGELOG.md` file, as a reminder for procedure.
 - backend: `pwdlib[argon2]` for password hashing
 - backend: provided `LOG_JSON_FORMAT` and `LOG_LEVEL` environment variable defaults in `run.sh` development script
 - backend: `User` model, `Session` model with migration script
diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md
new file mode 100644
index 0000000..2a2b00d
--- /dev/null
+++ b/RELEASE_CHECKLIST.md
@@ -0,0 +1,8 @@
+# Release Checklist
+
+1. Ensure `backend/pyproject.toml` and `frontend/package.json` have the correct version number for the upcoming release.
+2. Ensure `CHANGELOG.md` contains all changes for the upcoming release, with the correct version number and date labeled.
+   - `Unreleased` section should not exist.
+   - The version should match `pyproject.toml` and `package.json`.
+3. Ensure all tests pass locally, as well as the CI/CD pipeline.
+4. Correct all linting errors and warnings.