Back to Skills

github-issue-standard

verified

Standard format for ALL GitHub issues created by SpecWeave. Ensures checkable acceptance criteria, task connections, working links, and consistent metadata. Activates for create GitHub issue, sync to GitHub, format GitHub issue, standardize issue.

View on GitHub

Marketplace

specweave

anton-abyzov/specweave

Plugin

sw-github

productivity

Repository

anton-abyzov/specweave
27stars

plugins/specweave-github/skills/github-issue-standard/SKILL.md

Last Verified

January 25, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/anton-abyzov/specweave/blob/main/plugins/specweave-github/skills/github-issue-standard/SKILL.md -a claude-code --skill github-issue-standard

Installation paths:

Claude
.claude/skills/github-issue-standard/
Powered by add-skill CLI

Instructions

# GitHub Issue Standard - Universal Format

**CRITICAL**: This is the **MANDATORY** format for ALL GitHub issues created by SpecWeave, whether for:
- User stories (individual us-*.md files)
- Epics/Features (FS-* folders)
- Increments (0001-* folders)
- Specs (spec-*.md files)

## Issue Title Format (MANDATORY)

### ✅ ONLY Allowed Title Formats

```
[FS-XXX][US-YYY] User Story Title    ← STANDARD (User Stories)
[FS-XXX] Feature Title               ← Rare (Feature-level only)
```

**Examples**:
- ✅ `[FS-059][US-003] Hook Optimization (P0)`
- ✅ `[FS-054][US-001] Fix Reopen Desync Bug (P0)`
- ✅ `[FS-048] Smart Pagination Feature`

### ❌ PROHIBITED Title Formats (NEVER USE)

```
[BUG] Title                          ← WRONG! Bug is a LABEL, not title prefix
[HOTFIX] Title                       ← WRONG! Hotfix is a LABEL
[FEATURE] Title                      ← WRONG! Feature is a LABEL
[DOCS] Title                         ← WRONG! Docs is a LABEL
[Increment XXXX] Title               ← DEPRECATED! Old format
```

**Why?** Type-based prefixes like `[BUG]` break traceability:
- Cannot link to Feature Spec (FS-XXX)
- Cannot link to User Story (US-YYY)
- Violates SpecWeave's data flow: `Increment → Living Docs → GitHub`

**What to do instead?**
1. Link work to a Feature (FS-XXX) in living docs
2. Create User Story (US-YYY) under that feature
3. Use GitHub **labels** for categorization: `bug`, `enhancement`, `hotfix`

### Validation

The GitHub client (`github-client-v2.ts`) enforces this:
- Rejects titles starting with `[BUG]`, `[HOTFIX]`, `[FEATURE]`, etc.
- Rejects deprecated `[Increment XXXX]` format
- Only allows `[FS-XXX][US-YYY]` or `[FS-XXX]` formats

---

## The Standard Format

### ✅ Required Elements

Every GitHub issue MUST include:

1. **Checkable Acceptance Criteria**
   - Use GitHub task checkbox format: `- [x]` or `- [ ]`
   - Include AC ID, description, priority, and testable flag
   - Example: `- [x] **AC-US4-01**: Description (P1, testable)`

2. **Checkable Ta

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
7480 chars