Skip to content

add .coderabbit.yaml#21820

Merged
ti-chi-bot[bot] merged 8 commits into
pingcap:masterfrom
qiancai:translate/config-coderabbitai
Jul 17, 2026
Merged

add .coderabbit.yaml#21820
ti-chi-bot[bot] merged 8 commits into
pingcap:masterfrom
qiancai:translate/config-coderabbitai

Conversation

@qiancai

@qiancai qiancai commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

This PR adds repository-level CodeRabbit configuration for Chinese documentation reviews.

  • It enables automatic reviews for pull requests targeting master and release-8.5, applies an assertive review profile, and instructs CodeRabbit to provide actionable, ready-to-commit suggestions without requesting changes.
  • It sets the review language to Simplified Chinese and uses the shared Chinese writing style as the knowledge base for Markdown reviews.
  • It extends the Chinese writing style with MySQL version notation guidance and a final checklist for writing, editing, and reviewing documentation.
  • It disables nonessential decorative output such as poems, fortune messages, and chat art.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Chores
    • Added automated code review configuration with an assertive review profile and Markdown-focused Chinese guidance.
    • Restricted automatic reviews to specific release branch patterns and tuned review pacing for faster iterations.
  • Documentation
    • Strengthened Markdown writing guidelines, including stricter MySQL version formatting requirements (e.g., no v prefix) and preserved official casing examples.
    • Added a final pre-publish checklist to help ensure accuracy, consistency, formatting quality, and fully actionable steps.

@qiancai qiancai added the translation/from-docs This PR is translated from a PR in pingcap/docs. label Jul 17, 2026
@ti-chi-bot ti-chi-bot Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 17, 2026
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@qiancai, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 32 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 044cd60d-61ec-4827-8c69-b753d60b6c8b

📥 Commits

Reviewing files that changed from the base of the PR and between 9258081 and f131710.

📒 Files selected for processing (1)
  • .coderabbit.yaml
📝 Walkthrough

Walkthrough

Adds CodeRabbit configuration for Chinese, branch-scoped Markdown reviews and extends shared writing guidance with MySQL version rules and a final documentation checklist.

Changes

CodeRabbit documentation review configuration

Layer / File(s) Summary
Documentation writing guidance
.agents/shared/writing-style.md
Adds MySQL version-formatting rules and a final checklist for documentation accuracy, structure, terminology, literals, links, formatting, and cross-references.
Review settings and Markdown guidance
.coderabbit.yaml
Configures Chinese localization, assertive reviews without change requests, branch-scoped auto-review, Markdown instructions, the writing-style guideline, and disabled chat art output.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

I’m a rabbit with a YAML tune,
Hopping through docs beneath the moon.
MySQL names stand crisp and bright,
Checklists guide each page just right,
Chinese reviews take flight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title matches the main change by naming the added repository-level .coderabbit.yaml config.
Description check ✅ Passed The description covers the required change summary, affected version, related PR link, and other template sections.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/shared/writing-style.md:
- Around line 212-213: Update the MySQL versioning rule in the writing-style
guide to cover all supported MySQL versions, including 5.7 and 9.x, or
explicitly scope the existing examples and restriction to MySQL 8.x. Ensure
automated reviews do not flag valid references to other MySQL versions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1558c0f6-3806-4996-a1fa-716a5b8ec014

📥 Commits

Reviewing files that changed from the base of the PR and between 9798a1f and 2437c55.

📒 Files selected for processing (1)
  • .agents/shared/writing-style.md

Comment thread .agents/shared/writing-style.md
Comment thread .coderabbit.yaml Outdated
Comment thread .coderabbit.yaml
Comment thread .coderabbit.yaml Outdated
Comment thread .coderabbit.yaml Outdated
Comment thread .coderabbit.yaml
Comment thread .coderabbit.yaml
Comment thread .coderabbit.yaml Outdated
Comment thread .coderabbit.yaml
@qiancai qiancai added the lgtm label Jul 17, 2026
@qiancai

qiancai commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator Author

/approve

@ti-chi-bot

ti-chi-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Jul 17, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 6088948 into pingcap:master Jul 17, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant