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

tidb-issue-metadata-guard

Standardizes TiDB GitHub issue creation and editing with templates, labels, and structured descriptions.

40.5k|6.2k|Updated Sep 6, 2015
Search Tags:#bug report#triage#gh CLI#gitHub#tidb#issue template#Labeling
One-click install
npx skills add https://github.com/pingcap/tidb --skill tidb-issue-metadata-guard
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tidb-issue-metadata-guard
Source: https://github.com/pingcap/tidb/tree/main/.agents/skills/tidb-issue-metadata-guard
Command: npx skills add https://github.com/pingcap/tidb --skill tidb-issue-metadata-guard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

TiDB GitHub issues often end up with inconsistent titles, missing template sections, wrong labels, or descriptions that bury key reproduction details, making triage and search difficult. This Skill enforces the repository's issue workflow so every bug report or tracking issue stays consistent and searchable.

Core Features & Use Cases

  • Template-driven issue creation: Starts new issues from the matching file under .github/ISSUE_TEMPLATE/ and fills sections with concrete values instead of placeholders.
  • Label hygiene: Applies component/*, severity/*, and affected-version labels explicitly via gh, with fallback comment-based labeling when permissions are missing.
  • Readable issue bodies: Keeps top-level repro summaries visible while folding long SQL, logs, and plans into <details> blocks, and preserves untouched sections when editing existing issues.
  • Use Case: When filing a TiDB wrong-result bug, the Skill searches existing issues first, drafts the body from the bug report template with minimal reproduction and version info, folds the full SQL into a details block, and applies severity/major plus the right component label.

Quick Start

Use the tidb-issue-metadata-guard skill to create a TiDB bug report issue from the repository template with proper labels and a folded reproduction section.

Frequently Asked Questions about tidb-issue-metadata-guard

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

FAQPage Schema
How do I create a TiDB bug report issue that follows the repository template?▼

Start from the matching file under .github/ISSUE_TEMPLATE/ instead of writing the body from scratch. Fill in minimal reproduction, expected behavior, actual behavior, and TiDB version, keeping the top-level summary visible and folding long SQL or logs into <details> blocks.

How should I label a TiDB GitHub issue correctly?▼

Apply labels explicitly with gh issue create or gh issue edit rather than relying on the UI. Add at least one component/* label, and for bugs add severity/* and affected-version labels; wrong results and execution failures on valid SQL use severity/major.

What severity label should a TiDB wrong-result bug get?▼

Wrong-result bugs use severity/major, as do queries that fail to execute on valid SQL such as internal planner or runtime errors. Complex-query or compatibility issues that are not confirmed wrong results and do not block execution use severity/moderate.

What if I lack permission to add labels to a GitHub issue?▼

First try adding labels by commenting /label <label name> on the issue. If that still does not work, add a separate comment containing Suggested labels: followed by the label names so maintainers can apply them.

How do I edit an existing TiDB issue without breaking its structure?▼

Fetch the current title, body, and labels first, then patch only the intended template sections while preserving untouched sections and metadata. Materialize the patched body in a local Markdown file and diff it against the current body before calling gh.

Related Skills

Explore More Software Engineering Skills→
tomzxtomzx
5

fix-issue

Coordinate GitHub bug-fix workflows from issue reproduction to PR creation.

Community
Advanced
PostalocityPostalocity
1

bug-triage

Analyze bug reports and stack traces to identify root causes and assign ownership.

Official
Intermediate
alex-quan-001alex-quan-001

dedicated-cloud-diag

Route TiDB Dedicated Cloud diagnosis requests to specialized sub-skills.

Community
Intermediate
jguadagnojguadagno
18

external-comms

Scan GitHub issues and discussions, draft responses, and route them for human review.

Community
Intermediate