Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add changelog (ISD-2719) #647

Merged
merged 4 commits into from
Jan 10, 2025
Merged

docs: add changelog (ISD-2719) #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e29a39c
docs: add changelog
amandahla Jan 9, 2025
89e9dfa
Merge branch '2/main' into add-changelog
amandahla Jan 9, 2025
db3b793
Update .github/pull_request_template.md
amandahla Jan 9, 2025
8c040d2
Merge branch '2/main' into add-changelog
amandahla Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
5 changes: 5 additions & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

Check warning on line 1 in docs/changelog.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker 

[vale] reported by reviewdog 🐶
[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.

Raw Output:
{"message": "[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.", "location": {"path": "docs/changelog.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

### 2025-01-09

- Add changelog for tracking user-relevant changes.
6 changes: 6 additions & 0 deletions docs/how-to/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading