Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue template for "Module Readiness Checklist" #8901

Merged
merged 5 commits into from
Mar 19, 2021

Conversation

clevinson
Copy link
Contributor

@clevinson clevinson commented Mar 17, 2021

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 and x/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.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@alexanderbez
Copy link
Contributor

Should we also require some base level minimum test coverage? e.g. at least 90% of the state-machine is covered and 70% of the client code?

clevinson and others added 2 commits March 17, 2021 14:30
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
@clevinson clevinson mentioned this pull request Mar 18, 2021
5 tasks
@shahankhatch shahankhatch self-requested a review March 18, 2021 12:59
@amaury1093 amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 19, 2021
@orijbot
Copy link

orijbot commented Mar 19, 2021

@mergify mergify bot merged commit c9ef428 into master Mar 19, 2021
@mergify mergify bot deleted the clevinson/module-readiness-checklist branch March 19, 2021 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants