file-crdb-issue

Files GitHub issues for CockroachDB using repo templates and labeling conventions.

32.4k|4.1k|Updated Feb 6, 2014
One-click install
npx skills add https://github.com/cockroachdb/cockroach --skill file-crdb-issue
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: file-crdb-issue
Source: https://github.com/cockroachdb/cockroach/tree/main/.claude/skills/file-crdb-issue
Command: npx skills add https://github.com/cockroachdb/cockroach --skill file-crdb-issue

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Filing well-structured issues on the cockroachdb/cockroach repository requires knowing its issue templates, label taxonomy, and Jira epic conventions, which is tedious to get right manually.

Core Features & Use Cases

  • Template-Based Issue Filing: Selects the correct issue template (bug report, feature request, performance inquiry) or uses a dedicated structure for investigation issues.
  • Label Discovery and Conventions: Queries the repo's labels via the GitHub CLI and applies the T-, A-, O-, and C- prefix conventions, always including the O-agent label.
  • Jira Epic Linking: Appends an Epic line to the issue body so automation associates the auto-created Jira issue with the right epic.
  • Use Case: After diagnosing a regression in the SQL schema changer, ask the assistant to file a bug report; it gathers details, previews the full issue with labels, and files it via gh after your confirmation.

Quick Start

File a bug report on cockroachdb/cockroach for the schema changer regression we just discussed, with the appropriate team and area labels.

Frequently Asked Questions about file-crdb-issue

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

FAQPage Schema
How do I file a GitHub issue for CockroachDB?

Use the repo's issue templates since blank issues are disabled: bug_report.md for reproducible bugs, feature_request.md for new functionality, and performance-inquiry.md for performance problems. The skill assembles the issue and files it with gh issue create after your confirmation.

What labels should I use on a CockroachDB GitHub issue?

CockroachDB uses prefixed labels: T- for team ownership (e.g., T-kv), A- for technical area (e.g., A-sql-optimizer), O- for origin, and C- for category like C-bug. Query existing labels with gh label list and never invent new ones.

How do I file an investigation issue instead of a bug report?

Investigation issues skip the bug template and use a structure with Summary, Findings, Code References, and Next Steps sections. Apply the C-investigation category label and omit bug-report sections like steps to reproduce.

Can I link a GitHub issue to a Jira epic in CockroachDB?

Yes, add a line like "Epic CRDB-12358" at the bottom of the issue body. Automation then associates the automatically created Jira issue with that epic, so no manual Jira footer is needed.

Does filing an issue require the GitHub CLI?

Yes, the workflow uses the gh CLI to list labels and create issues against cockroachdb/cockroach. You must have gh installed and authenticated with permission to file issues on the repository.