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

chore(docs): add missing param to gov readme #18181

Merged
merged 1 commit into from
Oct 19, 2023
Merged

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Oct 19, 2023

Description

add missing param to readme


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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

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...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • New Feature: Introduced a new setting in the governance module, named min_initial_deposit_ratio. This feature allows users to adjust the minimum initial deposit ratio, enhancing the flexibility of the governance system. The default value is set at "0.1", providing a sensible starting point for most users.

@tac0turtle tac0turtle marked this pull request as ready for review October 19, 2023 17:19
@tac0turtle tac0turtle requested a review from a team as a code owner October 19, 2023 17:19
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 19, 2023

Walkthrough

The proposed change introduces a new parameter min_initial_deposit_ratio to the governance module. This parameter, a string type with a default value of "0.1", adjusts the minimum initial deposit ratio for governance proposals.

Changes

File Summary
x/gov/README.md Added a new parameter min_initial_deposit_ratio to the governance module.

🐇

In the realm of code, changes are afoot,

A new parameter, not just any old input.

"0.1" it stands, a ratio so fine,

For governance proposals, it's the starting line.

So hop along, let's celebrate this day,

For in the world of code, we've made our way. 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.
  • Additionally, enter @coderabbitai pause to halt the bot's ongoing reviews as any issue or review comment. To
    resume reviews, enter @coderabbitai resume as any issue or review comment.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 67fbfcd and 7f75544.
Files selected for processing (1)
  • x/gov/README.md (1 hunks)
Additional comments (Suppressed): 1
x/gov/README.md (1)
  • 773-773: The addition of the min_initial_deposit_ratio parameter to the documentation is a good step towards keeping the documentation up-to-date with the codebase. However, it would be helpful to include a brief description of what this parameter does in the context of the governance module. This would aid developers in understanding its purpose and how to use it effectively.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm!

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Oct 19, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Oct 19, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Oct 19, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Oct 19, 2023
Merged via the queue into main with commit 13adf11 Oct 19, 2023
47 checks passed
@julienrbrt julienrbrt deleted the marko/addparam_gov branch October 19, 2023 21:08
mergify bot pushed a commit that referenced this pull request Oct 19, 2023
julienrbrt pushed a commit that referenced this pull request Oct 19, 2023
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:x/gov
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants