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(specs): update app version for params v3 #3962

Merged
merged 1 commit into from
Oct 11, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Oct 10, 2024

I missed this when reviewing #3735

@rootulp rootulp self-assigned this Oct 10, 2024
@rootulp rootulp requested review from liamsi and a team as code owners October 10, 2024 19:31
@rootulp rootulp requested review from staheri14 and removed request for a team October 10, 2024 19:31
@celestia-bot celestia-bot requested a review from a team October 10, 2024 19:32
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

📝 Walkthrough

Walkthrough

The pull request updates the document specs/src/parameters_v3.md to reflect the new application version 3. The primary change is the increment of the consensus.Version.AppVersion parameter from 2 to 3, which is marked as governance modifiable. The document maintains its table structure, detailing global and module parameters, their default values, and governance modifiability. No new parameters were added or removed, and it highlights that certain parameters remain hardcoded.

Changes

File Path Change Summary
specs/src/parameters_v3.md Updated consensus.Version.AppVersion from 2 to 3; no other parameters changed.

Possibly related PRs

Suggested labels

WS: V2 ✌️

Suggested reviewers

  • ninabarbakadze
  • cmwaters
  • rach-id

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a7476c6 and 7669bcc.

📒 Files selected for processing (1)
  • specs/src/parameters_v3.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
specs/src/parameters_v3.md (1)

35-35: LGTM: App version correctly updated to 3

The consensus.Version.AppVersion parameter has been correctly updated from 2 to 3, which aligns with the PR objectives and the document title "Parameters v3". This change is consistent with the rest of the document, and no other modifications were necessary.

To ensure consistency, let's verify that no other instances of the previous version number exist in the file:


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

Copy link
Contributor

@cmwaters cmwaters 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 a bit weird because I don't feel like app version has a default

@rootulp
Copy link
Collaborator Author

rootulp commented Oct 11, 2024

Oh good point, maybe we should rename that column to Default / value or split the parameters into ones that are modifiable with a column heading of default and non-modifiable with a column heading of value.

@rootulp rootulp merged commit d61a686 into celestiaorg:main Oct 11, 2024
35 checks passed
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.

4 participants