skills.rest
pingcap
pingcapOFFICIAL
Explore all skills by this author →
Website𝕏@PingCAPGitHub

docs-pr-metadata-guard

Preserves pingcap/docs pull request template structure while editing PR metadata fields.

617|718|Updated Jul 23, 2016
Search Tags:#cherry-pick#gh CLI#Documentation#gitHub#PR template#tidb#Pull request
One-click install
npx skills add https://github.com/pingcap/docs --skill docs-pr-metadata-guard
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-pr-metadata-guard
Source: https://github.com/pingcap/docs/tree/main/.agents/skills/docs-pr-metadata-guard
Command: npx skills add https://github.com/pingcap/docs --skill docs-pr-metadata-guard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Editing GitHub pull request bodies in pingcap/docs often breaks the required PR template structure—headings get renamed, HTML comments get deleted, version checkboxes get reordered, and required sections go missing. This Skill keeps every PR body compliant with the repository's template while you fill in only the mutable fields.

Core Features & Use Cases

  • Template-safe PR creation: Start new PRs from .github/pull_request_template.md and submit with gh pr create --body-file or -T so the canonical structure is preserved.
  • Version checkbox and branch rules: Apply the correct affected-version checkboxes, base branch selection (master, release-8.5 for TiDB Cloud, or release-X.Y), and cherry-pick labels like needs-cherry-pick-release-8.5.
  • Translation and label conventions: Fill This PR is translated from: for docs-cn translations and apply labels such as translation/from-docs-cn or requires-version-specific-changes.
  • Use Case: When updating an existing PR, edit only the description text, version checkboxes, and related-link fields while keeping hidden HTML comments, the tips paragraph, and the first-time contributors' checklist rules intact.

Quick Start

Create a pull request for pingcap/docs using the repository PR template, check the correct TiDB version checkboxes, and keep all template comments and sections intact.

Frequently Asked Questions about docs-pr-metadata-guard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a pull request for pingcap/docs with the correct template?▼

Copy `.github/pull_request_template.md` into a local Markdown file, fill in the mutable fields, then submit with `gh pr create --body-file <file>` or `gh pr create -T .github/pull_request_template.md`. Review the file against the template before submitting.

Which TiDB version checkboxes should I select in a docs PR?▼

Check `master` only for general improvements, wording fixes, and corrections not tied to released behavior. Also check affected release branches when the change involves version-specific behavior, compatibility changes, changed defaults, or fixes in published docs.

Which base branch should a TiDB documentation PR target?▼

Default to `master` for most documentation changes. Use `release-8.5` for TiDB Cloud documentation, and a specific `release-X.Y` branch only when the change is scoped to a single published version that does not apply to master.

How do cherry-pick labels work for multi-version docs changes?▼

Open one PR on the latest applicable branch and add `needs-cherry-pick-release-X.Y` labels for remaining maintained versions. If wording differs per branch, check the version-specific checkbox and add the `requires-version-specific-changes` label.

What parts of the pingcap/docs PR template must not be edited?▼

Do not rename headings, reorder sections, delete hidden HTML comments, remove the version tips paragraph and CONTRIBUTING.md link, or add or reorder version checkbox lines. Only the description text, checkboxes, and related-link fields are mutable.

Related Skills

Explore More Software Engineering Skills→
LaiTszKinLaiTszKin
4

open-source-pr-workflow

Prepare review-ready pull requests with standardized branch naming and structured English PR bodies.

Community
Advanced
sgl-projectsgl-project
33.0k

sglang-cherrypick

Triggers and monitors bot-cherry-pick GitHub workflow runs for merged PRs onto SGLang release branches.

Official
Advanced
nieomylniejanieomylnieja
3

markdown

Lint, format, and validate links in Markdown documents.

Community
Intermediate
atomicinnovationatomicinnovation
30

describe-pr

Generate pull request descriptions from diffs, commits, and templates.

Official
Intermediate