From cd55d7a56f978a3ba710bb375296dda099cd6336 Mon Sep 17 00:00:00 2001 From: Chloe Kudryavtsev Date: Tue, 25 Oct 2022 08:35:27 -0400 Subject: [PATCH] chore: improve contributing release guidelines --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ef053b53..9b5c6d195 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -139,6 +139,14 @@ To generate the changelog, we use a standard shortlog command: `git shortlog --f The person performing the release process should build the next CHANGELOG section based on this output, not use it as-is. Full releases should also remove any pre-release CHANGELOG sections. +Here is the step by step checklist: +1. If **stable** release, announce the comment period. Restart the comment period if a blocker bug is found and fixed. +2. Edit various `package.json`s to the new version. +3. Write a new entry into the changelog. + You should use the `git shortlog --format='%h %s' --group=trailer:changelog LAST_TAG..` command to get general data, + then rewrite it in a human way. +4. Tag the commit with the changes in 2 and 3 (if together, else the latter). + ## Translation [![Translation status](http://translate.akkoma.dev/widgets/foundkey/-/svg-badge.svg)](http://translate.akkoma.dev/engage/foundkey/)