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

docs: Module account address documentation #22289

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: Module account address documentation #22289

wants to merge 5 commits into from

Conversation

ziscky
Copy link
Contributor

@ziscky ziscky commented Oct 16, 2024 •
edited by coderabbitai bot
Loading

Description

Closes: #9916

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, you can find examples of the prefixes below:
  • confirmed ! in 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
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Introduced a new documentation file outlining Module Accounts, including address generation and account permissions during initialization.

@julienrbrt julienrbrt changed the title feat(docs): Module account address documentation docs: Module account address documentation Oct 16, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 31, 2024 •
edited
Loading

📝 Walkthrough

Walkthrough

This pull request introduces a new documentation file named 19-module-account.md, which details the concept of Module Accounts within a software application. It explains the deterministic generation of addresses for module accounts based on the module name, in accordance with ADR-028. The document also describes the initialization of account permissions during application startup and includes references to specific lines of Go code in the Cosmos SDK repository for further context.

Changes

File Change Summary
docs/build/building-modules/19-module-account.md New documentation file outlining Module Accounts, address generation, and account permissions.

Assessment against linked issues

Objective Addressed Explanation
Update building a module documentation with section about address generation (#9916) ✅

Possibly related PRs

Suggested labels

Type: ADR

Suggested reviewers

  • julienrbrt
  • sontrinh16
  • akhilkumarpilli
📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c754b20 and 2ea67e6.

📒 Files selected for processing (1)
  • docs/build/building-modules/19-module-account.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/build/building-modules/19-module-account.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ziscky ziscky marked this pull request as ready for review October 31, 2024 13:38
@ziscky ziscky requested a review from a team as a code owner October 31, 2024 13:38
julienrbrt
julienrbrt reviewed Oct 31, 2024
View reviewed changes
docs/build/building-modules/19-module-account.md

# Module Accounts

## Address Generation
Copy link
Member

Choose a reason for hiding this comment

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

That's a bit short for it to be in a dedicated page maybe. Having it in building modules is as well weird. Maybe an advanced concept?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julienrbrt julienrbrt julienrbrt left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees

@julienrbrt julienrbrt

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update building a module documentation with section about address generation
2 participants
@ziscky @julienrbrt