Release Checklist
๐ค Developerโ
๐ฃ Create an End-of-Release Reviewโ
- Create a new branch from
develop
.
- Create a Pull Request from your review branch to
main
.
This method allows the developer and reviewer to see all changes since the previous release.
Why not create a develop
-> main
PR for the review?
- Peer reviewers may request code changes.
develop
is a protected branch that can only be pushed into through a PR.- Using an unprotected branch
r#-final-review
allows direct pushes to address review comments.
๐ Hold Reviewโ
- Inform peer reviewer(s) and await review comments.
- Push review fixes to your
r#-final-review
branch. - After approval(s), when your code is passing all CI checks, you may merge to
main
.
๐งน Cleanupโ
- Since
develop
also needs the changes added tor#-final-review
, open a PR to mergemain
intodevelop
. - Have the same reviewers approve the PR.
๐ฅ Peer Reviewersโ
This is the last chance for a review of the code before it is immortalized forever as a new release.
Some checks aren't currently automated.
Please paste the following comment template into the review:
## Documents
- [ ] ICD
- [ ] Current interfaces (grpc & rest)
- [ ] Current relevant document links
- [ ] SDD
- [ ] Description of grpc & rest handler implementations
- [ ] Current sequence diagrams where applicable
- [ ] Current relevant document links
- [ ] CONOPS
- [ ] Current information
- [ ] Bibliography (if any citations)
- [ ] README (see svc-cargo for example)
- [ ] Badges
- [ ] Accurate installation instructions
- [ ] Current links to other documents
- [ ] Arrow DAO links
## Code (not applicable to examples/ folder)
- [ ] No unhandled unwrap()s
- [ ] Accurate (!) code comments on all functions
- [ ] No `# Arguments` and `# Returns` in function comments
- [ ] Function arguments checked where possible
- [ ] Sufficient logger (info, warn, and debug) messages
- [ ] Sensible Types (unsigned vs. signed)
## REST API
- [ ] Return codes accurately documented with openapi
- [ ] Return codes make sense
- [ ] Sufficiently descriptive error messages
## Cargo.toml(s)
- [ ] Package versions correct
- [ ] No minor versions specified
- [ ] Links to crates.io package, not git branch
(Confirm items with an x
, e.g. - [x] Lorem ipsum
)
The above template will be updated for future releases.