Add issue template for "Module Readiness Checklist" #8901
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
For Regen Ledger we've decided to adopt a formal checklist for performing internal audits of modules before publishing them live in a stable release.
It's been suggested (and also discussed w/ @aaronc & @shahankhatch) that it would be useful to adopt that same process for all new modules being merged into the SDK. This PR represents our proposal for such a checklist. We're happy to upgrade it with any suggestions from the wider group of Cosmos SDK core devs.
Rendered Preview.
Once this gets approved & merged, we'd like to kick off the process by going through a corresponding internal audit using this checklist for
x/authz
andx/fee_grant
modules.Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/
) or specification (x/<module>/spec/
)godoc
comments.Unreleased
section inCHANGELOG.md
Files changed
in the Github PR explorerCodecov Report
in the comment section below once CI passes