a/code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #3660 from cdr/jsjoeio/docs-update-changelog-process

Browse Source 
docs(MAINTAINING): update changelog process
This commit is contained in:
Joe Previte 2021-06-28 10:04:51 -07:00 committed by GitHub
commit a355012560
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -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
docs/MAINTAINING.md
View File

@ -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