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: ADR 046 - Module Params #10214

Merged
merged 21 commits into from
Oct 14, 2021
Merged

docs: ADR 046 - Module Params #10214

merged 21 commits into from
Oct 14, 2021

Conversation

alexanderbez
Copy link
Contributor

@alexanderbez alexanderbez commented Sep 22, 2021

ref: #9913


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)

@alexanderbez alexanderbez added C:x/params T: ADR An issue or PR relating to an architectural decision record labels Sep 22, 2021
@alexanderbez alexanderbez changed the title ADR 046 - Module Params docs: ADR 046 - Module Params Sep 22, 2021
@alexanderbez alexanderbez marked this pull request as ready for review September 24, 2021 22:26
@alexanderbez
Copy link
Contributor Author

Marking this read to review. Let me know if this is what you had in mind @aaronc. Naturally, this ADR doesn't include much in the way of technical code or protocol design, as most of the logic is simply in defining data structures and x/gov really takes care of the rest.

@Terra854
Copy link
Contributor

Since we are deprecating x/params, may i suggest that we add some text regarding it in the title and abstract?

@alexanderbez
Copy link
Contributor Author

Since we are deprecating x/params, may i suggest that we add some text regarding it in the title and abstract?

It's already mentioned in Backwards Compatibility. I don't think it's necessary to mention that in the abstract.

Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

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

concept ACK

docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

Thanks for writing. Let comments and suggestions.

docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Show resolved Hide resolved
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.

Generally looks good. Robert left some comments, would be good to address the comments and merge. Lets get started on this and get all the modules migrated.

Copy link
Collaborator

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

It's good in general. Thanks for responding to comments. Let's merge / update 2 suggestions before merging and maybe check again on the stateless usage.

docs/architecture/adr-046-module-params.md Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Show resolved Hide resolved
docs/architecture/adr-046-module-params.md Outdated Show resolved Hide resolved
@alexanderbez alexanderbez added the A:automerge Automatically merge PR once all prerequisites pass. label Oct 14, 2021
@mergify mergify bot merged commit 3d8cac3 into master Oct 14, 2021
@mergify mergify bot deleted the bez/adr-module-params branch October 14, 2021 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T: ADR An issue or PR relating to an architectural decision record
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants