celestiaorg / celestia-app

Celestia consensus node
https://celestiaorg.github.io/celestia-app/
Apache License 2.0
346 stars 293 forks source link

docs(specs): update app version for params v3 #3962

Closed rootulp closed 1 month ago

rootulp commented 1 month ago

I missed this when reviewing https://github.com/celestiaorg/celestia-app/pull/3735

coderabbitai[bot] commented 1 month ago
📝 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 - **#3870**: This PR introduces support for version 3 of the application, which is directly related to the main PR's update of the `consensus.Version.AppVersion` parameter to 3. - **#3914**: This PR adds documentation for "Parameters v3," which includes the updated `parameters_v3.md` file mentioned in the main PR, indicating a direct connection to the changes made. ## 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 a7476c6c7e7d8bbb82f9570999130d188be20c2f and 7669bcc051ed33987ca360a9d508f24215d573a9.
📒 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
rootulp commented 1 month ago

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.