Skip to content

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

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#23728
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

  • Documentation
    • Updated the pull request template wording and punctuation to make change descriptions clearer.
    • Clarified when documentation updates should reference related code changes.
    • Added a dedicated bullet for linking related code change pull requests.

@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

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: 11aa8d77-78cc-42c7-ac6b-c5445fe7ec81

📥 Commits

Reviewing files that changed from the base of the PR and between 359ff26 and bc6ccf1.

📒 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

The pull request template updates heading punctuation and expands the reference-links section with guidance and a field for related code change pull requests.

Changes

Pull Request Template

Layer / File(s) Summary
Template wording and reference links
.github/pull_request_template.md
The change heading adds a comma. The reference-links comment now covers related code changes and adds a corresponding pull request field.

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

Merge Risk: ⚪ Minimal · up to bc6cc

This updates pull request guidance to request related code-change links for documentation updates. The change is ready to merge with no identified product or runtime risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding a code PR field to the pull request template.
Description check ✅ Passed The description covers the required change, affected TiDB version, related links, AI involvement, and change classification. It also explains why the new code PR field is needed.
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.

@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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 3e7fa7cb-8a2d-4d38-8793-7848bd93597c

📥 Commits

Reviewing files that changed from the base of the PR and between 49887c1 and 359ff26.

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

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

Comment thread .github/pull_request_template.md Outdated
@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 commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator Author

/approve

@qiancai qiancai added the lgtm label Sep 4, 2026
@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 100a630 into pingcap:master Sep 4, 2026
12 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