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.

Sign up for GitHub

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

Jump to bottom

feat!: x/gov: raise max description length to 10k chars #10740

Merged
merged 4 commits into from
Dec 13, 2021
Merged

feat!: x/gov: raise max description length to 10k chars #10740

merged 4 commits into from
Dec 13, 2021

Conversation

ValarDragon
Copy link
Contributor

@ValarDragon ValarDragon commented Dec 12, 2021 •
edited
Loading

The 5k character limit for governance proposals is something I've ran into several times now. This feels like an artificial constraint. The deposit is our mechanism to combat spam, and extra state used for this is really not a problem.

In this PR I propose raising this limit to 10k characters, to remove much of the immediate need for working around this 5k limit.

Description

Closes: #XXXX

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
  • 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)

@ValarDragon
x/gov: raise max description length to 10k chars
87fb3bd 
The 5k character limit for governance proposals is something I've ran into several times now. This feels like an artificial constraint. The deposit is our mechanism to combat spam, and extra state used for this is really not a problem.

In this PR I propose raising this limit to 10k characters, to remove much of the immediate need for working around this 5k limit.
@ValarDragon ValarDragon changed the title x/gov: raise max description length to 10k chars feat! x/gov: raise max description length to 10k chars Dec 12, 2021
@ValarDragon ValarDragon changed the title feat! x/gov: raise max description length to 10k chars feat!: x/gov: raise max description length to 10k chars Dec 12, 2021
@ValarDragon
Copy link
Contributor Author

Test failures seem to be due to API limits? (See prior commit, where all except broken liveness tests passed)

tac0turtle
tac0turtle approved these changes Dec 12, 2021
View reviewed changes
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

LGTM

@tac0turtle
Copy link
Member

@ValarDragon would you want this backported

@alexanderbez
Copy link
Contributor

@ValarDragon would you want this backported

I don't think we can -- this is state breaking AFAICT

@tac0turtle tac0turtle added the A:automerge Automatically merge PR once all prerequisites pass. label Dec 12, 2021
@mergify mergify bot merged commit ea2bcc8 into master Dec 13, 2021
@mergify mergify bot deleted the dev/increase-gov-description-lenegth branch December 13, 2021 09:24
@ValarDragon
Copy link
Contributor Author

yeah its state breaking, can't backport unfortunately

@mergify mergify bot mentioned this pull request Jan 10, 2022
Merged
mergify bot pushed a commit that referenced this pull request Jan 10, 2022
@ValarDragon
feat!: x/gov: raise max description length to 10k chars (#10740)
3cbeb1b 
The 5k character limit for governance proposals is something I've ran into several times now. This feels like an artificial constraint. The deposit is our mechanism to combat spam, and extra state used for this is really not a problem.

In this PR I propose raising this limit to 10k characters, to remove much of the immediate need for working around this 5k limit.

<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Closes: #XXXX

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

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

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

(cherry picked from commit ea2bcc8)

# Conflicts:
#	CHANGELOG.md
@robert-zaremba
Copy link
Collaborator

I think this makes sense, especially that we prune past proposals.

amaury1093 pushed a commit that referenced this pull request Jan 10, 2022
@mergify @ValarDragon @robert-zaremba
feat!: x/gov: raise max description length to 10k chars (backport #10740
a5c60b7 
) (#10921)

* feat!: x/gov: raise max description length to 10k chars (#10740)

The 5k character limit for governance proposals is something I've ran into several times now. This feels like an artificial constraint. The deposit is our mechanism to combat spam, and extra state used for this is really not a problem.

In this PR I propose raising this limit to 10k characters, to remove much of the immediate need for working around this 5k limit.

<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Closes: #XXXX

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

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

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

(cherry picked from commit ea2bcc8)

# Conflicts:
#	CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
@faddat faddat mentioned this pull request Feb 28, 2022
Closed
8 tasks
@0xHansLee 0xHansLee mentioned this pull request Jun 22, 2022
Merged
2 tasks
JimLarson pushed a commit to agoric-labs/cosmos-sdk that referenced this pull request Jul 7, 2022
@mergify @ValarDragon
@robert-zaremba @JimLarson
feat!: x/gov: raise max description length to 10k chars (backport cos…
8bd5180 
…mos#10740) (cosmos#10921)

* feat!: x/gov: raise max description length to 10k chars (cosmos#10740)

The 5k character limit for governance proposals is something I've ran into several times now. This feels like an artificial constraint. The deposit is our mechanism to combat spam, and extra state used for this is really not a problem.

In this PR I propose raising this limit to 10k characters, to remove much of the immediate need for working around this 5k limit.

<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Closes: #XXXX

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

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

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

(cherry picked from commit ea2bcc8)

# Conflicts:
#	CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
JeancarloBarrios pushed a commit to agoric-labs/cosmos-sdk that referenced this pull request Sep 28, 2024
@mergify @ValarDragon
@robert-zaremba @JeancarloBarrios
feat!: x/gov: raise max description length to 10k chars (backport cos…
70ef863 
…mos#10740) (cosmos#10921)

* feat!: x/gov: raise max description length to 10k chars (cosmos#10740)

The 5k character limit for governance proposals is something I've ran into several times now. This feels like an artificial constraint. The deposit is our mechanism to combat spam, and extra state used for this is really not a problem.

In this PR I propose raising this limit to 10k characters, to remove much of the immediate need for working around this 5k limit.

<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Closes: #XXXX

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

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

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [x] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

(cherry picked from commit ea2bcc8)

# Conflicts:
#	CHANGELOG.md

* Update CHANGELOG.md

* Update CHANGELOG.md

Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle approved these changes

@alexanderbez alexanderbez alexanderbez approved these changes

@aaronc aaronc Awaiting requested review from aaronc

Assignees
No one assigned
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:x/gov
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ValarDragon @tac0turtle @alexanderbez @robert-zaremba