Skip to content
New issue

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

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

Already on GitHub? # to your account

Add module readiness checklist issue template #287

Merged
merged 1 commit into from
Mar 8, 2021

Conversation

clevinson
Copy link
Member

@clevinson clevinson commented Mar 6, 2021

Basic template from @aaronc's suggestions in #253

Some ideas of things that may be missing from here:

  • do we need to audit anything about intermodule wiring in cases where that happens?
  • I added a note about documentation (godoc + readme.md). We currently don't have the same docs structure as in the cosmos-sdk (where module directories have .md files with docs that get copied to their vuepress). What is our general documentation expectation for high level docs about things like functionlaity, store usage, API surface, events, etc.?
  • Where in this checklist do we check for correct signature verifications? (e.g. that GetSIgners() is setup correctly for all Msg's), anything else abt authentication that we should add in this checklist?
  • Do we need to add any base level x/upgrade support (now that we have consensusVersion, etc. from @technicallyty and @AmauryM's work?) as part of "Internal completeness audit" ?

@codecov
Copy link

codecov bot commented Mar 6, 2021

Codecov Report

Merging #287 (a6025b4) into master (88e7ed4) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #287   +/-   ##
=======================================
  Coverage   62.76%   62.76%           
=======================================
  Files          47       47           
  Lines        2968     2968           
=======================================
  Hits         1863     1863           
  Misses        893      893           
  Partials      212      212           

Copy link
Member

@aaronc aaronc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK

@aaronc aaronc merged commit 12de78e into master Mar 8, 2021
@ryanchristo ryanchristo deleted the clevinson/module-readiness-checklists branch July 2, 2022 22:09
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants