// Use when creating or editing TiDB pull requests so PR title scope, PR template fields, hidden HTML comments, and bot-parsed checklist sections stay intact. Trigger on tasks involving PR creation, PR body updates, issue linking from a PR, test checklist updates, or investigating labels like do-not-merge/needs-tests-checked.
Use when deciding whether make bazel_prepare is required before build or test commands based on local file changes in TiDB.
Use when creating or editing TiDB GitHub issues so issue templates, labels, issue titles, and issue descriptions stay consistent with repository workflow. Trigger on tasks involving issue creation, bug reports, enhancement tracking issues, label selection, or searching for existing issues and PRs before filing a new one.
Decide where to place TiDB tests and how to write them (basic structure, naming, testdata usage). Use when asked about test locations, writing conventions, shard_count limits, casetest categorization, or when reviewing test changes in code review.
Use when running TiDB package tests and deciding whether failpoint enable/disable is required before and after the test command.
Use when recording TiDB integration tests under tests/integrationtest and verifying regenerated result files stay minimal and correct.
Use when running tests under tests/realtikvtest that require a local TiUP playground lifecycle with strict startup, readiness checks, and cleanup.
| name | tidb-pr-metadata-guard |
| description | Use when creating or editing TiDB pull requests so PR title scope, PR template fields, hidden HTML comments, and bot-parsed checklist sections stay intact. Trigger on tasks involving PR creation, PR body updates, issue linking from a PR, test checklist updates, or investigating labels like do-not-merge/needs-tests-checked. |
Use this skill for TiDB GitHub pull request metadata updates. The goal is to preserve repository-required PR structure while editing only the mutable fields.
Before changing a PR body, read .github/pull_request_template.md.
.github/pull_request_template.md instead of writing the body from scratch.
pkg [, pkg2, pkg3]: what is changed or *: what is changed.pkg means the TiDB module area, not a literal Go package path. For example, changes under pkg/planner/core usually map to planner, not pkg/planner/core.gh pr create -T .github/pull_request_template.md.Issue Number:, Problem Summary:, the content under ### What changed and how does it work?, test checkbox states and concrete commands, and the release-note block.Tests <!-- At least one of them must be included. --> unchanged.No need to test nested block and its HTML comment unchanged.tidb-issue-metadata-guard to create or identify the issue first, then patch only the Issue Number: line in the PR body.gh.do-not-merge/needs-linked-issuedo-not-merge/needs-tests-checked.github/pull_request_template.md before changing anything else.Issue Number: line, and that line can reference one or more related issues with full keyword syntax such as close #<id> and ref #<id>.planner, executor, or *:, not raw Go package paths such as pkg/planner/core.Tests line still includes the template HTML comment verbatim.No need to test is checked with a reason.