From 54d2b743787e6429ac28143cf777c1ff6b898112 Mon Sep 17 00:00:00 2001 From: teor Date: Thu, 8 Dec 2022 08:38:41 +1000 Subject: [PATCH] change(doc): Update release, ticket, and PR templates (#5793) * Update release-checklist.md * Add complex code or requirements to the PR template * Add complex code and testing sections to the ticket template Remove the design section, because we're not using it * Merge freeze and merge PRs --- .github/ISSUE_TEMPLATE/feature_request.md | 12 +++++++++--- .github/PULL_REQUEST_TEMPLATE/release-checklist.md | 5 ++++- .github/pull_request_template.md | 9 +++++---- 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b1efafcf..9ac8226f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -23,11 +23,17 @@ If this changes network behaviour, quote and link to the Bitcoin network referen https://developer.bitcoin.org/reference/p2p_networking.html --> -### Designs +### Complex Code or Requirements + +### Testing + + ## Related Work diff --git a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md index e75f070d..12424ca0 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md @@ -89,7 +89,7 @@ We use [the Release Drafter workflow](https://github.com/marketplace/actions/rel We follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. To create the final change log: -- [ ] Copy the draft changelog into `CHANGELOG.md` +- [ ] Copy the **latest** draft changelog into `CHANGELOG.md` (there can be multiple draft releases) - [ ] Delete any trivial changes. Keep the list of those, to include in the PR - [ ] Combine duplicate changes - [ ] Edit change descriptions so they are consistent, and make sense to non-developers @@ -125,6 +125,8 @@ After you have the version increments, the updated checkpoints and the updated c - [ ] Turn on [Merge Freeze](https://www.mergefreeze.com/installations/3676/branches). - [ ] Once the PR is ready to be merged, unfreeze it [here](https://www.mergefreeze.com/installations/3676/branches). Do not unfreeze the whole repository. +- [ ] Update the PR to the latest `main` branch using `@mergifyio update`. Then Mergify should merge it in-place. + If it makes a merge PR instead, that PR will get cancelled by the merge freeze. So just merge the changelog PR manually. ### Create the Release @@ -141,6 +143,7 @@ After you have the version increments, the updated checkpoints and the updated c the previous release. - [ ] Mark the release as 'pre-release', until it has been built and tested - [ ] Publish the pre-release to GitHub using "Publish Release" +- [ ] Delete all the [draft releases from the list of releases](https://github.com/ZcashFoundation/zebra/releases) ## Binary Testing diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a9e7f004..0948a430 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,11 +14,11 @@ If this PR changes network behaviour, quote and link to the Bitcoin network refe https://developer.bitcoin.org/reference/p2p_networking.html --> -### Designs +### Complex Code or Requirements ## Solution @@ -32,7 +32,7 @@ Does it close any issues? ### Reviewer Checklist @@ -41,6 +41,7 @@ If you want a specific reviewer for this PR, tag them here. - [ ] Does it need extra CHANGELOG info? (new features, breaking changes, large changes) - [ ] Are the PR labels correct? - [ ] Does the code do what the ticket and PR says? + - [ ] Does it change concurrent code, unsafe code, or consensus rules? - [ ] How do you know it works? Does it have tests? ## Follow Up Work