Skip to content

Commit 1e8ee0d

Browse files
amandahlaerinecon
andauthored
docs: add changelog (ISD-2719) (#647)
* docs: add changelog * Update .github/pull_request_template.md Co-authored-by: Erin Conley <erin.conley@canonical.com> --------- Co-authored-by: Erin Conley <erin.conley@canonical.com>
1 parent cf27952 commit 1e8ee0d

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,6 @@ Please, provide some information about your PR before proceeding.
3333
- [ ] The documentation is generated using `src-docs`
3434
- [ ] The documentation for charmhub is updated.
3535
- [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`)
36+
- [ ] The changelog is updated with changes that affect the users of the charm.
3637

3738
<!-- Explanation for any unchecked items above -->

docs/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
### 2025-01-09
4+
5+
- Add changelog for tracking user-relevant changes.

docs/how-to/contribute.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ Run the following command:
6363
echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit
6464
chmod +x .git/hooks/pre-commit
6565
```
66+
### Changelog
67+
68+
Please ensure that any new feature, fix, or significant change is documented by
69+
adding an entry to the `docs/changelog.md` file.
70+
71+
To learn more about changelog best practices, visit [Keep a Changelog](https://keepachangelog.com/).
6672

6773
## Build charm
6874

0 commit comments

Comments
 (0)