-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add module readiness checklist issue template (#287)
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Module Readiness Checklist | ||
about: Pre-flight checklist that modules must pass before ready for being enabled in stable builds of regen ledger | ||
labels: 'module-readiness-checklist' | ||
--- | ||
|
||
- [ ] Good unit and integration test coverage for all state machine logic (@assignee) | ||
- [ ] Internal API audit (at least 1 person) (@assignee) | ||
- [ ] Are Msg and Query methods and types well-named and organized? | ||
- [ ] Is everything well documented (godoc as well as README.md in module directory) | ||
- [ ] Internal state machine audit (at least 2 people) (@assignee1, @assignee2) | ||
- [ ] Read through MsgServer code and verify correctness upon visual inspection | ||
- [ ] Ensure all state machine code which could be confusing is properly commented | ||
- [ ] Make sure state machine logic matches Msg method documentation | ||
- [ ] Ensure that all state machine edge cases are covered with tests and that test coverage is sufficient | ||
- [ ] Assess potential threats for each method including spam attacks and ensure that threats have been addressed sufficiently. This should be done by writing up threat assessment for each method | ||
- [ ] Assess potential risks of any new third party dependencies and decide whether a dependency audit is needed | ||
- [ ] Internal completeness audit, fully impleted with tests (at least 1 person) (@assignee) | ||
- [ ] Genesis import and export of all state | ||
- [ ] Query services | ||
- [ ] CLI methods | ||
- [ ] Testnet / devnet testing after above internal audits | ||
- [ ] All Msg methods have been tested especially in light of any potential threats identified | ||
- [ ] Genesis import and export has been tested | ||
- [ ] Nice to have (and needed in some cases if threats could be high): official 3rd party audit |