Skip to content

Commit 266f742

Browse files
yhaliawyanksyoon
andauthored
Refactor changelog-related files (#265)
* Refactor changelog-related files * Fix heading level in changelog * docs: add changelog to index * docs: move changelog (delete original) --------- Co-authored-by: Yanks Yoon <[email protected]> Co-authored-by: Yanks Yoon <[email protected]>
1 parent 178e18b commit 266f742

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,6 @@ Applicable spec: <link>
2828
- [ ] The documentation for charmhub is updated.
2929
- [ ] The changelog `docs/changelog.md` is updated.
3030
- [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`)
31+
- [ ] The docs/changelog.md is updated with user-relevant changes in the format of [keep a changelog v1.1.0](https://keepachangelog.com/en/1.1.0/)
3132

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

docs/changelog.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
6+
7+
Each revision is versioned by the date of the revision.
8+
39
### 20250-03-11
410

511
- docs: fix charm architecture diagram (separate charm containers boundary)

docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,4 @@ Thinking about using the WordPress Operator for your next project? [Get in touch
5555
1. [Themes](reference/themes.md)
5656
1. [Explanation](explanation)
5757
1. [Charm architecture](explanation/charm-architecture.md)
58+
1. [Changelog](changelog.md)

0 commit comments

Comments
 (0)