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

docs-issue-metadata-guard

Enforces issue templates, labels, and scope rules for pingcap/docs GitHub issues.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating or editing GitHub issues in the pingcap/docs repository requires strict adherence to three issue templates, a docs-only scope boundary, and a specific label taxonomy, and mistakes lead to malformed or misrouted issues.

Core Features & Use Cases

  • Template Enforcement: Selects and fills the correct template (Error Report, Change Request, or Question) since blank issues are disabled and gh issue create does not auto-apply templates or labels.
  • Scope Discipline: Keeps issues within the docs-only boundary by redirecting product bugs to other pingcap repositories and support questions to community channels.
  • Label Management: Applies type, area, priority, and workflow labels explicitly via gh CLI flags, with a fallback comment when label permissions are missing.
  • Use Case: When filing a typo report for a TiDB documentation page, the skill searches existing issues first, creates the issue with the Error Report template, fills both required fields, and adds type/bug plus the relevant area/* label.

Quick Start

Create a GitHub issue in pingcap/docs reporting a broken link on the TiDB quick-start page using the correct template and labels.

Frequently Asked Questions about docs-issue-metadata-guard

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

FAQPage Schema
How do I create a GitHub issue for pingcap/docs using the correct template?▼

Use gh issue create with the --template flag set to Error Report, Change Request, or Question, since blank issues are disabled in this repository. Fill every template field with concrete information and add labels explicitly via -l flags.

What issue templates does the pingcap/docs repository provide?▼

The repository provides three templates: Error Report for typos and broken links, Change Request for new or restructured content, and Question for documentation usage questions. Blank issues are disabled in config.yml.

Why doesn't gh issue create apply template labels automatically?▼

The gh CLI does not auto-apply labels defined in issue template front matter. You must pass labels explicitly with -l flags, such as type/bug or an area/* label, when creating the issue.

Can I file a TiDB product bug report in the pingcap/docs repository?▼

No, the docs repository only accepts documentation-related issues. Product bugs belong in the appropriate repository under github.com/pingcap/, and technical support questions should go to TiDB community channels like Discord or Slack.

How should I edit an existing GitHub issue without breaking its template?▼

Fetch the current title, body, and labels first, then patch only the intended sections while preserving headings, numbered prompts, and HTML comments. Diff the patched body against the original before submitting with gh issue edit.

Related Skills

Explore More Software Engineering Skills→
FriendlyInternetFriendlyInternet
10

issue-dedup

Search open and closed GitHub issues before creating new ones.

Official
Advanced
robertolopezlopezrobertolopezlopez
1

github-pr-comment-analysis

Group unresolved GitHub pull request comments into actionable issue sections.

Community
Advanced
brainbrewlabsbrainbrewlabs
7

doc-review

...

Official
Intermediate
edictum-aiedictum-ai
29

fix-audit-issue

Create a feature branch, fix an audit issue, and submit a pull request.

Official
Intermediate