Skip to content

Commit 3226a53

Browse files
committed
docs: update CHANGELOG process
1 parent 4b0dd07 commit 3226a53

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,4 @@ If there is no existing issue, please first create one unless the fix is minor.
55
Please make sure the base of your PR is the default branch!
66
-->
77

8-
## Checklist
9-
10-
- [ ] updated `CHANGELOG.md`
8+
Fixes #

docs/MAINTAINING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,14 @@ To save time when creating a new release for code-server, we keep a running chan
8787

8888
If either author or reviewer of a PR believe the change should be mentioned in the `CHANGELOG`, then it should be added.
8989

90-
If there is not a "Next Version" when you modify `CHANGELOG`, please add it using the template you see near the top of `CHANGELOG`. You can use the suggested format: `<pr title> <pr #> <author> Example: `fix: Check the logged user instead of $USER #3330 @videlanicolas`
90+
If there is not a "Next Version" when you modify `CHANGELOG`, please add it using the template you see near the top of `CHANGELOG`.
91+
92+
As for what you should write for your changelog item, we should asking yourself these two questions:
93+
94+
1. How do these changes affect code-server users?
95+
2. What actions do they need to take? (if any)
96+
97+
If you need inspiration, we suggest looking at the [Emacs changelog](https://github.com/emacs-mirror/emacs/blob/master/etc/NEWS).
9198

9299
## Release
93100

0 commit comments

Comments
 (0)