From e29a39c77d6a60da90ac4f9f0d269eddbb87e4a3 Mon Sep 17 00:00:00 2001 From: Amanda Hager Lopes de Andrade Katz Date: Thu, 9 Jan 2025 15:35:00 -0300 Subject: [PATCH 1/2] docs: add changelog --- .github/pull_request_template.md | 1 + docs/changelog.md | 5 +++++ docs/how-to/contribute.md | 6 ++++++ 3 files changed, 12 insertions(+) create mode 100644 docs/changelog.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 97391fc3..743df77b 100644 --- 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 affects the users of the charm. diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 00000000..45dafb75 --- /dev/null +++ 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 index f9cf8839..0f64226a 100644 --- 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 From db3b793d69c6081ead4697a59db53b9b9beaa2b3 Mon Sep 17 00:00:00 2001 From: "Amanda H. L. de Andrade Katz" Date: Thu, 9 Jan 2025 16:48:39 -0300 Subject: [PATCH 2/2] Update .github/pull_request_template.md Co-authored-by: Erin Conley --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 743df77b..418edfb5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -33,6 +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 affects the users of the charm. +- [ ] The changelog is updated with changes that affect the users of the charm.