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

docs: add folder structure and contents #116

Merged
merged 6 commits into from
Sep 17, 2021

Conversation

jaybxyz
Copy link
Contributor

@jaybxyz jaybxyz commented Sep 16, 2021

Description

This PR adopts documentation folder structure from cosmos-cash project and adds essential documents for how to set-up and build farmingd and how to use functions exist in the farming module.

Tasks

References

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 added the documentation Improvements or additions to documentation label Sep 16, 2021
@jaybxyz jaybxyz added this to the Farming F1 MVP milestone Sep 16, 2021
@jaybxyz jaybxyz self-assigned this Sep 16, 2021
@codecov
Copy link

codecov bot commented Sep 16, 2021

Codecov Report

Merging #116 (12c89c8) into master (e64f916) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #116   +/-   ##
=======================================
  Coverage   69.67%   69.67%           
=======================================
  Files          25       25           
  Lines        2259     2259           
=======================================
  Hits         1574     1574           
  Misses        533      533           
  Partials      152      152           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e64f916...12c89c8. Read the comment docs.

@jaybxyz
Copy link
Contributor Author

jaybxyz commented Sep 16, 2021

If #114 and #115 are planning to be reviewed and merged first, then I will update api and cli docs accordingly.

* master:
  feat: add budget module on simapp (tendermint#118)
  feat: fix epoch params (tendermint#103)
  chore: fix typo
  test: add TestOutstandingRewards
  style: sort imports
  feat: add AdvanceEpoch message and tx cli endpoint
  feat: add cli query commands
  test: write test for Rewards query endpoint
  test: write test for TotalStaking query endpoint
  test: write test for Staking query endpoint
  feat: implement new query endpoints
  docs: update spec document
  fix: include OutstandingRewards in genesis
  fix: fix epoch advancing criteria
  fix: use sdk.DecCoins for rewards
  fix: set total staking on InitGenesis and use helper methods
  feat: add OutstandingRewards
  chore: remove unnecessary validation from InitGenesis
  fix: fix InitGenesis
@jaybxyz jaybxyz marked this pull request as ready for review September 17, 2021 02:13
Copy link
Contributor

@dongsam dongsam left a comment

Choose a reason for hiding this comment

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

LGTM

@jaybxyz jaybxyz merged commit 560929f into tendermint:master Sep 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants