Merge branch '2/main' into fix-matrix-auth-lib

canonical · Jan 10, 2025 · 01b4fbb · 01b4fbb
2 parents 59c28d4 + 1e8ee0d
commit 01b4fbb
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -33,5 +33,6 @@ Please, provide some information about your PR before proceeding.
 - [ ] The documentation is generated using `src-docs`
 - [ ] The documentation for charmhub is updated.
 - [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`)
+- [ ] The changelog is updated with changes that affect the users of the charm.
 
 <!-- Explanation for any unchecked items above -->
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### 2025-01-09
+
+- Add changelog for tracking user-relevant changes.
diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md
@@ -63,6 +63,12 @@ Run the following command:
 echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit
 chmod +x .git/hooks/pre-commit
 ```
+### Changelog
+
+Please ensure that any new feature, fix, or significant change is documented by
+adding an entry to the `docs/changelog.md` file.
+
+To learn more about changelog best practices, visit [Keep a Changelog](https://keepachangelog.com/).
 
 ## Build charm