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
This commit is contained in:
teor 2022-12-08 08:38:41 +10:00 committed by GitHub
parent a5d04746a1
commit 54d2b74378
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 8 deletions

View File

@ -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
<!--
If this change is part of a Zebra design, quote and link to the RFC:
https://github.com/ZcashFoundation/zebra/tree/main/book/src/dev/rfcs/
Does this PR change concurrency, unsafe code, or complex consensus rules?
If it does, explain how we will implement, review, and test it.
-->
### Testing
<!--
How can we check that this change does what we want it to do?
-->
## Related Work

View File

@ -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

View File

@ -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
<!--
If this PR implements a Zebra design, quote and link to the RFC:
https://github.com/ZcashFoundation/zebra/tree/main/book/src/dev/rfcs/
Does this PR change concurrency, unsafe code, or complex consensus rules?
If it does, ask for multiple reviewers on this PR.
-->
## Solution
@ -32,7 +32,7 @@ Does it close any issues?
<!--
Is this PR blocking any other work?
If you want a specific reviewer for this PR, tag them here.
If you want specific reviewers for this PR, tag them here.
-->
### 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