ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Release checklist (markdown)

James Groom 2022-12-13 09:48:51 +10:00
parent 6a7b7452e1
commit da6301a973
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Release-checklist.md

@ -5,7 +5,7 @@ Note that some of these can be done concurrently.
1. Test Issues labelled "Patch pending" 1. Test Issues labelled "Patch pending"
1. Write the changelog 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 - 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](#changelog-structure). Use past tense and all lowercase, omitting the period. If you find yourself needing to start a new sentence, you're being too verbose. 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. - After parsing through the commits to get a list of user-facing changes, group them as in [the example below](#changelog-structure). Use past tense and all lowercase, omitting the period. If you find yourself needing to start a new sentence then you're being too verbose. 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. - 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). - 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. - 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.