From 989ba51cb95b4cb9e4cdca958821840d4d613eaf Mon Sep 17 00:00:00 2001 From: Pili Guerra Date: Tue, 2 Nov 2021 16:36:47 +0100 Subject: [PATCH] Update release-checklist.md (#3001) Include potential changes to the README in the release checklist Co-authored-by: Conrado Gouvea --- .github/PULL_REQUEST_TEMPLATE/release-checklist.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md index 8ebe8447b..b3f72af27 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md @@ -92,6 +92,17 @@ Also check for crates that depend on crates that have changed. They should get a - [ ] After any changes, test that the `cargo install` command in works. Use e.g. `cargo install --locked --path zebrad`. + +## README + +As we resolve various outstanding known issues and implement new functionality with each release, we should double check the README for any necessary updates. + +We should check and update if necessary: + +- [ ] The "Beta Release" section +- [ ] The "Known Issues" section + +to ensure that any items that are resolved in the latest release are no longer listed in the README. ## Change Log