From 113bedf193e9bef6454df57d32df9561271309b5 Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 13 Dec 2022 09:47:08 +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 51ed4e5..1c82af4 100644 --- a/Release-checklist.md +++ b/Release-checklist.md @@ -5,7 +5,7 @@ Note that some of these can be done concurrently. 1. Test Issues labelled "Patch pending" 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. TODO write a bespoke tool for editing changelog - - 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 unless no Issue exists. + - After parsing through the commits to get a list of user-facing changes, group them as in the example below. Use past tense. It really doesn't matter if you use BrE or AmE spellings, just make sure that menu items are in AmE as that's the only localisation at the moment. You should include Issue numbers for bugs and feature requests, but not PRs unless no Issue exists. - 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.