Skip to content

Conventions

Naming

  • Skill names: ghs- prefix + kebab-case (e.g., ghs-repo-scan)
  • Directory names match skill names exactly
  • Check slugs: kebab-case (e.g., branch-protection)
  • GitHub Project items: health findings use [Tier N] <check-name> titles; issue items reference the original GitHub issue number

Trigger Phrases

  • Include 2-4 natural trigger phrases in the skill description
  • Cover common phrasings (e.g., "scan my repo", "audit my project", "run a health check")

Status Indicators

IndicatorMeaningColor
[PASS]Check passedGreen
[FAIL]Check failed (action needed)Red
[WARN]Cannot verify (permissions/API)Yellow
[INFO]Informational (no score impact)Blue

Terminal Output

  • Use tables for structured data
  • Progress bars: ████░░░░ (8 chars wide, filled with , empty with )
  • Keep output scannable --- headers, spacing, alignment
  • Use stage banners from ui-brand.md at the start of every major phase
  • Use checkpoint boxes from ui-brand.md before pausing for human input
  • Use the defined symbol set (✓ ✗ ⚠ ◆ ○ ⚡) --- never random emoji

Allowed Tools

Common patterns:

  • Read-only skills: Read Glob
  • GitHub API skills: Bash(gh:*) Read
  • Fix skills: Bash(gh:*) Bash(git:*) Read Write Edit Glob Grep Task

Shared References

All shared reference docs live in .claude/skills/shared/references/. Skills reference them via ../shared/references/<file>.md.

FilePurpose
gh-cli-patterns.mdAuth, repo detection, context detection, API patterns, error handling
projects-format.mdGitHub Projects item structure, field names, status values, tier system, scoring rules
scoring-logic.mdTier weights, score formula, priority algorithm
output-conventions.mdStatus indicators, tables, progress bars, summary blocks
ui-brand.mdVisual output branding: stage banners, checkpoint boxes, status symbols, routing blocks
argument-parsing.mdStandardized $ARGUMENTS parsing: repo detection, flags, item slugs, defaults
checkpoint-patterns.mdTyped human-in-the-loop patterns: verification, decision, action, confirmation
agent-spawning.mdWorktree-based parallel agent patterns, context budgets
implementation-workflow.mdRepo prep, worktree mgmt, branch/commit/push/PR workflow
edge-cases.mdRate limiting, content filters, permission errors, retries
item-categories.mdHealth item classification (Category A/B/CI) and routing
config.mdCentralized scoring constants and display thresholds
sync-format.mdSync contract: labels, issue body template, metadata
agent-result-contract.mdUniversal agent JSON response format
gsd-integration.mdGSD framework detection, command patterns, complexity routing
state-persistence.mdGitHub Issue-based session state across context resets

Shared Templates

Reusable output templates live in .claude/skills/shared/templates/. Skills use these for generated output (PRs, comments, issues) with {placeholder} variable substitution.

TemplateUsed ByPurpose
pr-body.mdbacklog-fix, issue-implement, action-fixPR description body
analysis-comment.mdissue-analyzeIssue analysis comment
review-comment.mdreview-prPR review comment
state-issue-body.mdbacklog-fix, orchestrate, dev-loopState issue body
sync-issue-body.mdbacklog-syncSynced issue body

Other shared directories:

  • Check registry: .claude/skills/shared/checks/index.md
  • EditorConfig templates: .claude/skills/shared/editorconfigs/

GSD Patterns

All skills follow structured prompt patterns:

  • XML tags --- <context>, <anti-patterns>, <objective>, <process> wrap major sections
  • Execution context --- <execution_context> lists all shared reference dependencies
  • Required reading --- <required_reading> declares prerequisites to load before execution
  • Anti-pattern tables --- 3-column Do NOT | Do Instead | Why format
  • Rule/trigger/example triples --- Rules state the imperative, triggers explain when, examples show concrete cases
  • Tables over prose --- Use markdown tables for check definitions, scoring weights, routing logic, and output specs
  • Good/bad example pairs --- Show what good output looks like and contrast with bad output
  • Goal-backward verification --- Agent-spawning skills verify Existence, Substance, and Wiring of outputs
  • Cognitive bias guards --- Diagnostic skills include bias antidote tables
  • Confidence levels --- Classification skills indicate High/Medium/Low confidence
  • Progressive disclosure --- Load indexes first, read individual items only when needed
  • Dry-run support --- Mutation skills support --dry-run to show plans without executing
  • Typed checkpoints --- Use checkpoint patterns for human-in-the-loop interactions

Released under the MIT License.