Skip to content

Conversation

@jaybxyz
Copy link
Contributor

@jaybxyz jaybxyz commented Oct 18, 2021

Description

This PR is the last one to improve documentation quality for the upcoming audit release.
Let's make documentation easy to read and resourceful. Make sure that all the necessary contents are there for other developers and auditors to test.

Tasks

  • Update README.md
  • Update TECHNICAL-SETUP.md

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.

  • Appropriate labels applied
  • Targeted PR against correct branch
  • 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
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@jaybxyz jaybxyz self-assigned this Oct 18, 2021
@jaybxyz jaybxyz marked this pull request as ready for review October 20, 2021 08:50
@jaybxyz jaybxyz requested a review from dongsam October 20, 2021 08:51
@jaybxyz jaybxyz merged commit 192c02d into tendermint:master Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants