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: improve documentation for audit release #178

Merged
merged 22 commits into from
Oct 18, 2021

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 before we work on #172.
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 (make it easy and intuitive for other developers to quickly get on board with farming module)
  • Update TECHNICAL-SETUP.md
  • Update spec docs up to date

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
@dongsam dongsam requested a review from hallazzang October 18, 2021 06:47
x/farming/spec/01_concepts.md Outdated Show resolved Hide resolved
x/farming/spec/05_end_block.md Outdated Show resolved Hide resolved
x/farming/spec/05_end_block.md Outdated Show resolved Hide resolved
x/farming/spec/03_state_transitions.md Outdated Show resolved Hide resolved
hallazzang and others added 12 commits October 18, 2021 16:39
this prevents from consuming 0 additional gas but calling `GetParams`
…ogisin/farming into kogisin/172-improve-docs-audit

* 'kogisin/172-improve-docs-audit' of https://github.com/kogisin/farming:
  Update x/farming/spec/03_state_transitions.md
  Update x/farming/spec/03_state_transitions.md
  Update x/farming/spec/03_state_transitions.md
  docs: update docs for `Stake` state transition
  docs: update doc for `DelayedStakingGasFee`
  fix: consume additional gas only if needed
@jaybxyz jaybxyz requested review from hallazzang and dongsam October 18, 2021 09:06
x/farming/spec/01_concepts.md Outdated Show resolved Hide resolved
x/farming/spec/01_concepts.md Outdated Show resolved Hide resolved
x/farming/spec/03_state_transitions.md Show resolved Hide resolved
x/farming/spec/03_state_transitions.md Outdated Show resolved Hide resolved
x/farming/spec/03_state_transitions.md Outdated Show resolved Hide resolved
@dongsam dongsam marked this pull request as ready for review October 18, 2021 09:33
@jaybxyz jaybxyz merged commit bea4b39 into tendermint:master Oct 18, 2021
jaybxyz added a commit to jaybxyz/farming that referenced this pull request Oct 27, 2021
* master: (22 commits)
  fix: use farmingPoolAcc and terminationAcc for consistency
  docs: add missing comments
  fix: last add_request_proposals
  docs: update renamed variables and remove mvp_legacy.md
  feat: rename public plan proposal requests
  feat: rename NewPublicPlanProposal to NewPublicPlanProposalHandler
  docs: update README.md
  fix: workflow target branch and description for main branch
  doc: fix to be broken links by renaming branch name
  move codeowners from contributing file to the CODEOWNERS file
  create CODEOWNERS file
  feat: generate proto files
  edit farming.proto
  docs: add os checking for sed -i option (tendermint#184)
  docs: specify which module is used for module name
  feat: bump budget to v0.1.1 (tendermint#177)
  docs: improve documentation for audit release (tendermint#178)
  fix: withdraw rewards only when staked amount changes (tendermint#180)
  fix: emit rewards_withdrawn only when positive amount is withdrawn
  docs: add helpful docs for audit (tendermint#176)
  ...

# Conflicts:
#	x/farming/simulation/proposals.go
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.

3 participants