Skip to content

docs: add code PR field to pull request template - #21916

Merged
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
qiancai:add-code-link-to-pr-template
Sep 4, 2026
Merged

docs: add code PR field to pull request template#21916
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
qiancai:add-code-link-to-pr-template

Conversation

@qiancai

@qiancai qiancai commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added, or deleted? (Required)

Add a dedicated field for related code change PRs to the pull request template. The new guidance asks contributors to provide the corresponding code PR when a documentation update is related to a code change, helping reviewers verify that documented behavior matches the implementation.

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

  • 文档
    • 更新 Pull Request 模板中的问题标题,补充必要标点。
    • 扩展相关链接填写说明:当文档变更关联代码变更时,需提供对应的代码 PR。
    • 新增相关代码变更 PR 字段,便于补充关联信息。

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 3, 2026
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: be6dd499-3848-48db-89b6-88b593f48a6d

📥 Commits

Reviewing files that changed from the base of the PR and between c21e946 and 41dc36d.

📒 Files selected for processing (1)
  • .github/pull_request_template.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

本次变更更新 PR 模板的变更说明标题和相关链接提示,并新增相关代码变更 PR 字段。

Changes

PR 模板填写说明

Layer / File(s) Summary
更新 PR 模板填写说明
.github/pull_request_template.md
修正变更说明标题中的逗号。细化相关链接提示,并新增可选的相关代码变更 PR 链接字段。

Estimated code review effort: 1 (简单) | ~5 分钟

Merge Risk: ⚪ Minimal · up to 41dc3

This updates contributor guidance for linking related code changes to documentation PRs. It has no runtime or deployment impact and is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题“docs: add code PR field to pull request template”简洁、明确,并准确概括了新增相关代码变更 PR 字段这一主要改动。
Description check ✅ Passed PR 描述完整覆盖必需部分,包括改动内容、适用版本、相关链接、AI 参与情况和变更类型。首次贡献者清单可按模板要求在非首次贡献者场景下移除,因此不影响通过。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ 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.

@qiancai qiancai added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Sep 3, 2026
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
@qiancai qiancai added the lgtm label Sep 4, 2026
@qiancai

qiancai commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator Author

/approve

@ti-chi-bot

ti-chi-bot Bot commented Sep 4, 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 Sep 4, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 2f6bf64 into pingcap:master Sep 4, 2026
10 of 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant