From 1ef4439f535671443225d95f2fec48ea6a7abfd5 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 3 Jun 2022 06:38:02 +1000 Subject: [PATCH] Updated Release checklist (markdown) --- Release-checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Release-checklist.md b/Release-checklist.md index 1c82376..86edfa3 100644 --- a/Release-checklist.md +++ b/Release-checklist.md @@ -4,7 +4,7 @@ Note that some of these can be done concurrently. - Ideally there would be a release candidate and rigorous testing, but there never seems to be enough time... 1. Write the changelog - You can use `git log --pretty='format:[%h %an] %s%n%b%n' 2.x..` (substitute the last release tag for "2.x") as a starting point. - - After parsing through the commits to get a list of user-facing changes, group them as in the example below. You should include Issue numbers for bugs and feature requests, but not PRs. + - After parsing through the commits to get a list of user-facing changes, group them as in the example below. Use past tense. You should include Issue numbers for bugs and feature requests, but not PRs. - This needs to be prepended to `/Assets/changelog.md` (Markdown) *immediately before* updating the `release` branch so that it ends up in the build artifacts. - It also needs to be prepended to [the `ReleaseHistory` article](https://tasvideos.org/Bizhawk/ReleaseHistory) (TASVideos wiki markup). Apart from changing markup language, also remember to include download links and the release date (will need to finish this after publishing). - There's also [the ext. tool changelog](https://github.com/TASEmulators/BizHawk-ExternalTools/wiki/Partial-changelog-for-ApiHawk). If an ApiHawk change doesn't affect Lua then it might not warrant inclusion on the main changelog, but this one includes even the tiny method signature changes.