Skip to content

Commit

Permalink
docs: update CHANGELOG process
Browse files Browse the repository at this point in the history
  • Loading branch information
jsjoeio committed Jun 23, 2021
1 parent 4b0dd07 commit 3226a53
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
4 changes: 1 addition & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,4 @@ If there is no existing issue, please first create one unless the fix is minor.
Please make sure the base of your PR is the default branch!
-->

## Checklist

- [ ] updated `CHANGELOG.md`
Fixes #
9 changes: 8 additions & 1 deletion docs/MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,14 @@ To save time when creating a new release for code-server, we keep a running chan

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

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`
If there is not a "Next Version" when you modify `CHANGELOG`, please add it using the template you see near the top of `CHANGELOG`.

As for what you should write for your changelog item, we should asking yourself these two questions:

1. How do these changes affect code-server users?
2. What actions do they need to take? (if any)

If you need inspiration, we suggest looking at the [Emacs changelog](https://github.com/emacs-mirror/emacs/blob/master/etc/NEWS).

## Release

Expand Down

0 comments on commit 3226a53

Please sign in to comment.