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 essential documents for set-up, build procedure, and executing guides #29

Merged
merged 13 commits into from
Sep 10, 2021

Conversation

jaybxyz
Copy link
Contributor

@jaybxyz jaybxyz commented Sep 10, 2021

Description

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

closes: #28

Bullet Points

  • add docs/Tutorials
    • init testnet with genesis setting for proposing budget(short voting period) and account balance for budget source accounts and collected budget accounts
    • add new budget plan sending a governance proposal ChangeParameterProposal
    • add a query to check balances of collection_address to see if the balances increase over time
  • update README.md
  • update TECHNICAL-SETUP.md

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 10, 2021
@jaybxyz jaybxyz self-assigned this Sep 10, 2021
@jaybxyz jaybxyz marked this pull request as ready for review September 10, 2021 07:20
docs/How-To/cli/README.md Outdated Show resolved Hide resolved
jaybxyz and others added 3 commits September 10, 2021 17:01
@dongsam dongsam merged commit 0f1eb01 into tendermint:master Sep 10, 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.

Write essential documents for setting up, building, and executing
2 participants