Agent skill

Docs PR Metadata Guard

by pingcap in pingcap/docs

A skill your agent uses when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay…

Custom licenceAuto-check passedDevelopment

Install Docs PR Metadata Guard

skills CLI
$ npx skills add pingcap/docs --skill docs-pr-metadata-guard -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install pingcap/docs docs-pr-metadata-guard --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-pr-metadata-guard .claude/skills/docs-pr-metadata-guard && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-pr-metadata-guard
GitHub stars
616
Token cost
~1.9k tokens
SKILL.md length
952 words
Files
1
Skills in repo
8
Repo updated
First seen
Licence
Custom licence

At a glance

A skill your agent uses when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay…

  • Works in 10 steps: Write PR titles and descriptions in… → For a new PR, start from… → Fill in the required sections with… → …
  • Editing pull requests in pingcap/docs so the PR template sections
  • SKILL.md covers Workflow, Version checkbox rules, Cherry-pick and label… and Quick checks
  • Calls gh

What it does

Docs PR Metadata Guard is an agent skill from pingcap/docs. Use when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay intact. Trigger on tasks involving PR creation, PR body updates, version selection, cherry-pick label decisions, or translating a PR from docs-cn.

Its SKILL.md is about 1.9k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Pull requests and Translation. It works with TiDB and GitHub. The repository describes itself as: TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

When your agent uses it

  • Editing pull requests in pingcap/docs so the PR template sections
  • Version checkboxes
  • Related-link fields
  • Description structure stay intact

Example prompts

  • “/docs-pr-metadata-guard”

Workflow steps

10 steps, taken from the first numbered list in SKILL.md.

  1. Write PR titles and descriptions in English.
  2. For a new PR, start from .github/pull_request_template.md instead of writing the body from scratch.
  3. Fill in the required sections with concrete information.
  4. Choose the correct base branch.
  5. For an existing PR, update only the mutable sections.
  6. Preserve hidden HTML comments exactly.
  7. Preserve the "Tips for choosing the affected version(s)" guidance block.
  8. Handle the first-time contributors' checklist correctly.
  9. Prefer file-based edits for GitHub metadata.
  10. After any PR body update, re-read the PR to verify the structure is intact.

What it can do on your machine

Read from SKILL.md and the folder at commit 6ba8576. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • gh

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use gh, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs PR Metadata Guard loads about 1.9k tokens when it runs. Until then it costs about 86 tokens; SKILL.md has 952 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~86
When it runs · the whole SKILL.md, loaded when a task matches
~1.9k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 952 words (~1,878 tokens).

“Use this skill for pingcap/docs GitHub pull request metadata work. The goal is to preserve the repository-required PR description structure while editing only the mutable fields.”

— opening of SKILL.md by pingcap, Custom licence
name
docs-pr-metadata-guard

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/docs-pr-metadata-guard of pingcap/docs.

Open the folder on GitHubat commit 6ba8576

Compare with similar skills

Docs PR Metadata Guard next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs PR Metadata Guard compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs PR Metadata Guard this skillpingcap/docs616—~1.9kAutomated safety check: PassCustom licence
Qiaomu Meta Skilljoeseesun/qiaomu-meta-skill383—~2.8kAutomated safety check: PassMIT
Harness ContributingFairladyZ625/harness-anything225—~4.2kAutomated safety check: PassAGPL-3.0
TiDB PR Metadata Guardpingcap/tidb41k—~703Automated safety check: PassApache-2.0
OpenDesign Contribution Flownexu-io/open-design100k—~3.5kAutomated safety check: NotesApache-2.0
PR Babysitteropeninterpreter/openinterpreter69k3 repos~4.2kAutomated safety check: PassApache-2.0

Similar skills

  • Qiaomu Meta Skill

    joeseesun/qiaomu-meta-skill

    Research, create, improve, migrate, evaluate, package, install-check, govern, and safely publish qiaomu-flavored agent skills from workflows, prompts, transcripts, docs, SOPs, runbooks, scripts, or…

    383 GitHub stars~2.8k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Harness Contributing

    FairladyZ625/harness-anything

    Contribute a public change to Harness Anything from a GitHub issue through an isolated worktree, scoped tests, manifest-selected gates, a complete bilingual PR body, review triage, and maintainer…

    225 GitHub stars~4.2k tokensUpdated today
    DevelopmentAuto-check passed
  • Creates and edits TiDB pull request titles and descriptions without breaking the PR template, and diagnoses bot labels that stay on because of template changes.

    41k GitHub stars~703 tokensUpdated today
    DevelopmentAuto-check passed
  • OpenDesign Contribution Flow

    nexu-io/open-design

    Helps newcomers contribute to OpenDesign: ship a skill or design system, translate docs, fix docs or report a bug, ending in a pull request or issue.

    100k GitHub stars~3.5k tokensUpdated today
    DevelopmentAuto-check: notes
  • PR Babysitter

    openinterpreter/openinterpreter

    Watches an open GitHub pull request until it merges, handling review comments, diagnosing CI failures and retrying flaky checks along the way.

    69k GitHub starsUsed in 3 repos~4.2k tokens
    DevelopmentAuto-check passed
  • Check PR

    onyx-dot-app/onyx

    Checks a GitHub, GitLab, or Perforce (p4) pull request (or merge request, or shelved changelist) for unresolved review comments, failing status checks, and incomplete PR descriptions.

    32k GitHub starsUsed in 2 repos~2.3k tokens
    DevelopmentAuto-check passed

More from pingcap/docs

All 8 skills in this repo
  • Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

    616 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • Release Notes

    pingcap/docs

    Evaluate whether a change needs a release note. An agent skill from pingcap/docs.

    616 GitHub stars~2.6k tokensUpdated today
    Auto-check passed
  • Create or update a zh translation PR from pingcap/docs to pingcap/docs-cn by using repo-local scripts to prepare change-unit translation inputs, apply minimal edits to the existing Chinese files…

    616 GitHub stars~2.9k tokensUpdated today
    Auto-check passed
  • Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.

    616 GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.

    616 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • A skill your agent uses when creating or editing GitHub issues in pingcap/docs so issue templates, required fields, scope boundaries, and labels stay consistent with repository workflow.

    616 GitHub stars~1.8k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Docs PR Metadata Guard

What does Docs PR Metadata Guard do?

A skill your agent uses when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay…. Docs PR Metadata Guard is an agent skill from pingcap/docs. Use when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay intact.

When should I use Docs PR Metadata Guard?

Docs PR Metadata Guard fits situations like: editing pull requests in pingcap/docs so the PR template sections; version checkboxes; related-link fields; description structure stay intact.

How do I install Docs PR Metadata Guard in Claude Code?

Run `npx skills add pingcap/docs --skill docs-pr-metadata-guard -a claude-code`. Or copy the skill folder (.agents/skills/docs-pr-metadata-guard in pingcap/docs) into .claude/skills/docs-pr-metadata-guard in your project. Claude Code loads it when a task matches its description.

How do I install Docs PR Metadata Guard in Codex?

Run `npx skills add pingcap/docs --skill docs-pr-metadata-guard -a codex`. Or copy the skill folder (.agents/skills/docs-pr-metadata-guard in pingcap/docs) into .agents/skills/docs-pr-metadata-guard in your project. Codex loads it when a task matches its description.

Can I use Docs PR Metadata Guard in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add pingcap/docs --skill docs-pr-metadata-guard -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-pr-metadata-guard, .gemini/skills/docs-pr-metadata-guard, .github/skills/docs-pr-metadata-guard and .opencode/skills/docs-pr-metadata-guard in your project.

What does Docs PR Metadata Guard need to run?

Going by SKILL.md and its folder, Docs PR Metadata Guard needs the command-line tools its instructions call (gh).

Does Docs PR Metadata Guard access the network?

SKILL.md contains no URLs. Its commands use gh, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Docs PR Metadata Guard safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs PR Metadata Guard use?

Docs PR Metadata Guard has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Docs PR Metadata Guard use?

About 1.9k tokens (SKILL.md is roughly 7.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs PR Metadata Guard?

Skills that share tags, products or a category with Docs PR Metadata Guard: Qiaomu Meta Skill (joeseesun/qiaomu-meta-skill, 383 stars), Harness Contributing (FairladyZ625/harness-anything, 225 stars), TiDB PR Metadata Guard (pingcap/tidb, 41k stars) and OpenDesign Contribution Flow (nexu-io/open-design, 100k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs PR Metadata Guard?

pingcap (a GitHub organization) maintains it in pingcap/docs, which has 616 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 7, 2026.

Source: pingcap/docs on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.