-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
docs: add module documentation testing #12762
Conversation
Waiting for the testing ADR. |
I wanted to link the distribution simulation as an example in the docs, and I've noticed it was moved to the wrong place (https://github.com/cosmos/cosmos-sdk/pull/12889/files#diff-f096725763ac01d0861d6f6d43cec03997c13b0397e1916a8284ed0d6f4e55be). I've moved them back where they should be. |
Codecov Report
@@ Coverage Diff @@
## main #12762 +/- ##
==========================================
+ Coverage 53.73% 54.05% +0.32%
==========================================
Files 645 645
Lines 55238 55238
==========================================
+ Hits 29682 29860 +178
+ Misses 23178 22999 -179
- Partials 2378 2379 +1
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left a few comments, I think this needs to be expanded quite a bit with short walkthroughs.
order: 1 | ||
--> | ||
|
||
# Dependency Injection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will be added after #12633. I am for keeping this boilerplate, as it permits me to link the testing documentation to here.
|
||
+++ https://github.com/cosmos/cosmos-sdk/blob/main/simapp/app_config.go | ||
|
||
+++ https://github.com/cosmos/cosmos-sdk/blob/main/simapp/app.go |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should open an issue to fill this out. Generally not a fan of just linking code as it doesn't explain why this and why that. This wouldn't provide much info to a new user.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As docs.cosmos.network default on v0.46, a new user won't see it until he digs.
I can remove the code, but I am really for to keep these files, as this allows me to already link to them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Totally fine it keep them, mainly thinking it would be useful to also break it down
Description
Explains how the Cosmos SDK is tested and how a module should be tested.
This follow the testing refactoring happening in the SDK.
Ref: #12696, #12398, #11899
cc @marbar3778 @alexanderbez @kocubinski @AmauryM @facundomedica
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!
to the type prefix if API or client breaking changeCHANGELOG.md
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!
in the type prefix if API or client breaking change