From 3226a53b0260eda1074514581a32c9e2672291a8 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 23 Jun 2021 15:37:01 -0700 Subject: [PATCH] docs: update CHANGELOG process --- .github/PULL_REQUEST_TEMPLATE.md | 4 +--- docs/MAINTAINING.md | 9 ++++++++- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cc6d2aa5..e240a5f4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 # diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index c56e5b33..a36281bc 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -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: ` 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