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

chore: fix doc changelog.md typo #22985

Closed
wants to merge 1 commit into from

Conversation

tiendn
Copy link

@tiendn tiendn commented Dec 18, 2024

Description

fix doc changelog.md typo


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

  • New Features

    • Support for simulating nested messages.
    • Importing hex keys via standard input.
    • Enhanced version command to return server information.
  • Improvements

    • Upgraded RocksDB libraries to version 9.
    • Simplified testing frameworks and removed redundant context in integration tests.
  • Bug Fixes

    • Disabled async pruning in the CLI.
    • Improved error handling in the BaseApp.Init method.
  • API Breaking Changes

    • Removed testutil/network package and deprecated certain client prompt validations.
    • Replaced AddGenesisAccount function with AddGenesisAccounts.

@tiendn tiendn requested a review from a team as a code owner December 18, 2024 16:59
Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

📝 Walkthrough

Walkthrough

The pull request focuses on updating the CHANGELOG.md file to document recent changes across multiple modules. The update includes a new "Unreleased" section that comprehensively captures recent developments, including new features, improvements, bug fixes, and breaking API changes. The changelog provides a detailed overview of modifications affecting various components, such as testing frameworks, RocksDB libraries, CLI commands, and server functionality.

Changes

File Change Summary
CHANGELOG.md - Added new [Unreleased] section
- Documented new features (nested message simulation, hex key import)
- Noted improvements in RocksDB and testing frameworks
- Recorded bug fixes for CLI and commit multistore
- Highlighted API breaking changes

Suggested labels

backport/v0.52.x

Possibly related PRs

Suggested reviewers

  • julienrbrt
  • tac0turtle
  • akhilkumarpilli
  • sontrinh16

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
CHANGELOG.md (1)

Line range hint 1-1248: LGTM! Well-structured changelog that follows best practices

The changelog is well organized with:

  • Clear version headers with dates
  • Proper categorization of changes
  • Links to PRs for reference
  • Clear marking of breaking changes
  • Detailed descriptions of changes

Consider making line wrapping more consistent throughout the file - some sections use different wrapping widths which affects readability slightly.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4d6c991 and a332af2.

📒 Files selected for processing (1)
  • CHANGELOG.md (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

@julienrbrt
Copy link
Member

Hey thanks! I am in the middle of releasing, so i'll do that here: #22986.

Note 2: At this time, we will not be accepting contributions that only fix spelling or grammar errors in documentation, code or elsewhere. The repository has a nightly job that spell checks all files and will automatically open PRs for any spelling errors.

@julienrbrt julienrbrt closed this Dec 18, 2024
@tiendn
Copy link
Author

tiendn commented Dec 18, 2024

Thanks

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.

2 participants