From b5c413c4ae48947fbe3f30ac116e9002815d4f4b Mon Sep 17 00:00:00 2001 From: jack1142 <6032823+jack1142@users.noreply.github.com> Date: Fri, 9 Jul 2021 19:46:36 +0200 Subject: [PATCH] Improve the documentation around the changelog and milestones --- source/core-devs/release-process.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/source/core-devs/release-process.rst b/source/core-devs/release-process.rst index 41e4839..4db75c2 100644 --- a/source/core-devs/release-process.rst +++ b/source/core-devs/release-process.rst @@ -54,7 +54,8 @@ Making a release .. tab:: Hotfix release This is a hotfix release, you should focus on getting the critical fix out, - everything else should not be important. + the other PRs should not be important. However, you should still update the milestone + to make your and others' job easier later. .. tab:: Everything else @@ -64,6 +65,13 @@ Making a release #. Review changelog PR. + .. note:: + + At this point, you should have an up-to-date milestone containing all PRs + that are contained in this release. If you're not sure if all PRs are properly assigned, + you might find the ``=getunreleasedcommits MILESTONE_NAME`` bot command + in one of testing channels on Red server useful. + .. tab:: Hotfix release Hotfix releases need to contain a changelog. @@ -73,9 +81,11 @@ Making a release .. tab:: Everything else - Add (or ask PR author to add) any missing entries based on the release's milestone. - Verify that contributors list is complete and in alphabetical order. - Merge the PR once it's ready. + - Add (or ask PR author to add) any missing entries based on the release's milestone. + - Update the contributors list in the changelog using contributors list for the milestone + that you can generate using ``=getcontributors MILESTONE_NAME`` bot command + in one of testing channels on Red server. + - Merge the PR once it's ready. #. Run "Prepare Release" workflow.