bigpowers 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitmessage +5 -0
- package/.releaserc.json +17 -0
- package/CHANGELOG.md +61 -0
- package/CLAUDE.md +61 -0
- package/CONVENTIONS.md +140 -0
- package/GEMINI.md +53 -0
- package/LICENSE +21 -0
- package/README.md +116 -0
- package/RELEASE.md +108 -0
- package/SKILL-INDEX.md +146 -0
- package/assess-impact/SKILL.md +76 -0
- package/audit-code/HEURISTICS.md +43 -0
- package/audit-code/SKILL.md +81 -0
- package/bin/bigpowers.js +27 -0
- package/change-request/REFERENCE.md +60 -0
- package/change-request/SKILL.md +42 -0
- package/commit-message/REFERENCE.md +81 -0
- package/commit-message/SKILL.md +39 -0
- package/countable-story-format.md +293 -0
- package/craft-skill/REFERENCE.md +88 -0
- package/craft-skill/SKILL.md +55 -0
- package/deepen-architecture/DEEPENING.md +37 -0
- package/deepen-architecture/INTERFACE-DESIGN.md +44 -0
- package/deepen-architecture/LANGUAGE.md +53 -0
- package/deepen-architecture/SKILL.md +76 -0
- package/define-language/SKILL.md +75 -0
- package/define-success/SKILL.md +60 -0
- package/delegate-task/SKILL.md +70 -0
- package/design-interface/SKILL.md +94 -0
- package/develop-tdd/SKILL.md +160 -0
- package/develop-tdd/deep-modules.md +33 -0
- package/develop-tdd/interface-design.md +31 -0
- package/develop-tdd/mocking.md +59 -0
- package/develop-tdd/refactoring.md +10 -0
- package/develop-tdd/tests.md +71 -0
- package/dispatch-agents/SKILL.md +72 -0
- package/edit-document/SKILL.md +14 -0
- package/elaborate-spec/SKILL.md +79 -0
- package/enforce-first/SKILL.md +75 -0
- package/execute-plan/SKILL.md +84 -0
- package/grill-me/REFERENCE.md +63 -0
- package/grill-me/SKILL.md +25 -0
- package/guard-git/REFERENCE.md +136 -0
- package/guard-git/SKILL.md +39 -0
- package/guard-git/scripts/block-dangerous-git.sh +41 -0
- package/guard-git/scripts/lib/git-guardrails-core.sh +29 -0
- package/hook-commits/SKILL.md +91 -0
- package/hooks/pre-tool-use.sh +130 -0
- package/index.js +6 -0
- package/inspect-quality/SKILL.md +101 -0
- package/investigate-bug/SKILL.md +111 -0
- package/kickoff-branch/SKILL.md +87 -0
- package/map-codebase/SKILL.md +66 -0
- package/migrate-spec/REFERENCE-GSD.md +137 -0
- package/migrate-spec/REFERENCE.md +186 -0
- package/migrate-spec/SKILL.md +150 -0
- package/model-domain/ADR-FORMAT.md +47 -0
- package/model-domain/CONTEXT-FORMAT.md +77 -0
- package/model-domain/SKILL.md +82 -0
- package/opencode.json +4 -0
- package/orchestrate-project/REFERENCE.md +89 -0
- package/orchestrate-project/SKILL.md +59 -0
- package/organize-workspace/REFERENCE.md +80 -0
- package/organize-workspace/SKILL.md +74 -0
- package/package.json +45 -0
- package/plan-refactor/SKILL.md +75 -0
- package/plan-release/SKILL.md +75 -0
- package/plan-work/SKILL.md +124 -0
- package/playwright.config.ts +56 -0
- package/release-branch/SKILL.md +116 -0
- package/request-review/SKILL.md +70 -0
- package/respond-review/SKILL.md +68 -0
- package/scripts/audit-compliance.sh +256 -0
- package/scripts/cleanup-worktrees.sh +44 -0
- package/scripts/install-cursor-skills-local.sh +13 -0
- package/scripts/install-cursor-skills.sh +34 -0
- package/scripts/install.sh +240 -0
- package/scripts/project-survey.sh +54 -0
- package/scripts/sync-skills.sh +110 -0
- package/seed-conventions/SKILL.md +185 -0
- package/session-state/SKILL.md +69 -0
- package/skills-lock.json +157 -0
- package/spike-prototype/SKILL.md +92 -0
- package/survey-context/SKILL.md +93 -0
- package/terse-mode/SKILL.md +35 -0
- package/trace-requirement/SKILL.md +68 -0
- package/using-bigpowers/SKILL.md +65 -0
- package/validate-fix/SKILL.md +93 -0
- package/visual-dashboard/SKILL.md +49 -0
- package/visual-dashboard/scripts/frame-template.html +189 -0
- package/visual-dashboard/scripts/helper.js +83 -0
- package/visual-dashboard/scripts/server.cjs +345 -0
- package/visual-dashboard/scripts/start-server.sh +121 -0
- package/visual-dashboard/scripts/stop-server.sh +46 -0
- package/wire-observability/SKILL.md +90 -0
- package/write-document/SKILL.md +63 -0
package/SKILL-INDEX.md
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
# Skill Index — Single Source of Truth
|
|
2
|
+
|
|
3
|
+
**Purpose:** One canonical reference for all bigpowers skills. Referenced by README.md, RELEASE-PLAN.md, and CONVENTIONS.md. Updated per-release.
|
|
4
|
+
|
|
5
|
+
**Last updated:** 2026-05-20 (v2.1.0 — reconciled orphan/ghost skills; 44 active, 6 planned)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Quick Navigation by BMAD Phase
|
|
10
|
+
|
|
11
|
+
| Phase | Active | Planned | Skills |
|
|
12
|
+
|---|---|---|---|
|
|
13
|
+
| **Bootstrap** | 1 | — | using-bigpowers |
|
|
14
|
+
| **Orchestrate** | 1 | — | orchestrate-project |
|
|
15
|
+
| **Discover** | 3 | — | survey-context, elaborate-spec, map-codebase |
|
|
16
|
+
| **Elaborate** | 5 | 1 | model-domain, define-language, grill-me, deepen-architecture, design-interface · _(grill-with-docs 📋)_ |
|
|
17
|
+
| **Plan** | 6 | 2 | assess-impact, change-request, define-success, plan-work, plan-refactor, plan-release · _(scope-work 📋, slice-tasks 📋)_ |
|
|
18
|
+
| **Spike** | 1 | — | spike-prototype |
|
|
19
|
+
| **Initiate** | 4 | — | kickoff-branch, guard-git, hook-commits, seed-conventions |
|
|
20
|
+
| **Build** | 5 | — | develop-tdd, enforce-first, delegate-task, dispatch-agents, execute-plan |
|
|
21
|
+
| **Harden** | 1 | — | wire-observability |
|
|
22
|
+
| **Bug** | 2 | 1 | investigate-bug, validate-fix · _(diagnose-root 📋)_ |
|
|
23
|
+
| **Review** | 4 | — | audit-code, request-review, respond-review, trace-requirement |
|
|
24
|
+
| **Integrate** | 2 | — | commit-message, release-branch |
|
|
25
|
+
| **Sustain** | 2 | — | inspect-quality, organize-workspace |
|
|
26
|
+
| **Utility** | 7 | 2 | terse-mode, craft-skill, edit-document, session-state, migrate-spec, visual-dashboard, write-document · _(setup-environment 📋, reset-baseline 📋)_ |
|
|
27
|
+
| **TOTAL** | **44** | **6** | |
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Full Reference Table
|
|
32
|
+
|
|
33
|
+
| # | Phase | Skill | Intent | Artefact Output | Status | Source |
|
|
34
|
+
|---|---|---|---|---|---|---|
|
|
35
|
+
| 1 | Bootstrap | `using-bigpowers` | Lifecycle intro; where to start | (dialogue) | ✅ Active | original |
|
|
36
|
+
| 2 | Orchestrate | `orchestrate-project` | Meta-skill enforcing 6-phase core loop (Standard / Fast-Track / Ad-Hoc modes) | (orchestration) | ✅ Active | original v2.0.0 |
|
|
37
|
+
| 3 | Discover | `survey-context` | Per-task context map; suggests next skill | (dialogue, update STATE.md) | ✅ Active | mattpocock/skills (zoom-out) |
|
|
38
|
+
| 4 | Discover | `elaborate-spec` | Dialogue to refine rough idea into spec | (dialogue) | ✅ Active | superpowers/brainstorming |
|
|
39
|
+
| 5 | Discover | `map-codebase` | High-fidelity codebase survey; stack, architecture, gray areas | CODEBASE-MAP.md | ✅ Active | original |
|
|
40
|
+
| 6 | Elaborate | `model-domain` | Interactive domain model; updates CONTEXT.md | CONTEXT.md, adr/ | ✅ Active | mattpocock/skills (domain-model) |
|
|
41
|
+
| 7 | Elaborate | `define-language` | Extract ubiquitous language glossary | UBIQUITOUS_LANGUAGE.md | ✅ Active | mattpocock/skills (ubiquitous-language) |
|
|
42
|
+
| 8 | Elaborate | `grill-me` | Stress-test design by grilling assumptions (Design mode + Docs mode) | (dialogue, refine design) | ✅ Active | mattpocock/skills (grill-me) |
|
|
43
|
+
| 9 | Elaborate | `grill-with-docs` | Grill assumptions grounded in real library docs | (dialogue, refine design) | 📋 Planned | mattpocock/skills (grill-with-docs) |
|
|
44
|
+
| 10 | Elaborate | `deepen-architecture` | Surface architecture deepening opportunities (Ousterhout deep modules) | (dialogue, update CONTEXT.md) | ✅ Active | mattpocock/skills (improve-codebase-architecture) |
|
|
45
|
+
| 11 | Elaborate | `design-interface` | Generate multiple radically different interface designs via parallel subagents | INTERFACE-OPTIONS.md | ✅ Active | original |
|
|
46
|
+
| 12 | Plan | `assess-impact` | Analyze blast radius of a proposed change before any code is written | IMPACT.md | ✅ Active | original |
|
|
47
|
+
| 13 | Plan | `change-request` | Add a new requirement or reorder epics by WSJF against RELEASE-PLAN.md | (updated RELEASE-PLAN.md) | ✅ Active | original |
|
|
48
|
+
| 14 | Plan | `scope-work` | Define what's in/out → SCOPE.md | SCOPE.md | 📋 Planned | mattpocock/skills (to-prd, adapted: local-first) |
|
|
49
|
+
| 15 | Plan | `slice-tasks` | Break work into vertical slices → TASKS.md | TASKS.md | 📋 Planned | mattpocock/skills (to-issues, adapted: local-first) |
|
|
50
|
+
| 16 | Plan | `define-success` | Convert imperative task to step → verify pairs | (dialogue, feed to plan-work) | ✅ Active | Karpathy principle |
|
|
51
|
+
| 17 | Plan | `plan-work` | Write detailed plan with verify steps | PLAN.md | ✅ Active | superpowers/writing-plans + Karpathy verify-template |
|
|
52
|
+
| 18 | Plan | `plan-refactor` | Plan a refactor via interview | REFACTOR.md | ✅ Active | mattpocock/skills (request-refactor-plan, adapted) |
|
|
53
|
+
| 19 | Plan | `plan-release` | Convert elaborated specs into a release plan with Gherkin acceptance criteria | RELEASE-PLAN.md | ✅ Active | original |
|
|
54
|
+
| 20 | Spike | `spike-prototype` | Throw-away spike for unknown problem spaces | SPIKE-<name>.md | ✅ Active | mattpocock/skills (prototype) |
|
|
55
|
+
| 21 | Initiate | `kickoff-branch` | Create worktree + branch + verify test baseline | (git state) | ✅ Active | superpowers/using-git-worktrees |
|
|
56
|
+
| 22 | Initiate | `guard-git` | Block dangerous git commands via pre-command hooks | (git state) | ✅ Active | mattpocock/skills (git-guardrails) |
|
|
57
|
+
| 23 | Initiate | `hook-commits` | Install pre-commit: lint, format, typecheck, test | (git state) | ✅ Active | mattpocock/skills (setup-pre-commit) |
|
|
58
|
+
| 24 | Initiate | `seed-conventions` | Generate CLAUDE.md + CONVENTIONS.md + specs/ scaffold | CLAUDE.md, CONVENTIONS.md, specs/ | ✅ Active | Akita "writing CLAUDE.md is a skill" |
|
|
59
|
+
| 25 | Build | `develop-tdd` | Red → green → refactor TDD loop | src/ (code) | ✅ Active | superpowers/tdd + mattpocock/tdd (override) |
|
|
60
|
+
| 26 | Build | `enforce-first` | F.I.R.S.T test-quality rubric (Fast, Independent, Repeatable, Self-Validating, Timely) | (checklist) | ✅ Active | Clean Code Ch.9 + Akita |
|
|
61
|
+
| 27 | Build | `delegate-task` | One subagent, one task, sequential + two-stage review | (code + review) | ✅ Active | superpowers/subagent-driven-development |
|
|
62
|
+
| 28 | Build | `dispatch-agents` | Multiple subagents in parallel on independent tasks | (code + review) | ✅ Active | superpowers/dispatching-parallel-agents |
|
|
63
|
+
| 29 | Build | `execute-plan` | Batch execute plan tasks sequentially with checkpoints | src/ (code per task) | ✅ Active | superpowers/executing-plans |
|
|
64
|
+
| 30 | Harden | `wire-observability` | Add structured JSON logging + idempotent setup + observability commands | CLAUDE.md (commands), src/ (logging) | ✅ Active | Akita "structured logging + idempotent setup" |
|
|
65
|
+
| 31 | Bug | `investigate-bug` | Investigate a bug → DIAGNOSIS.md | DIAGNOSIS.md | ✅ Active | mattpocock/skills (triage-issue, adapted: local-first) |
|
|
66
|
+
| 32 | Bug | `diagnose-root` | 4-phase root cause (reproduce → isolate → hypothesize → verify) | (dialogue, update DIAGNOSIS.md) | 📋 Planned | superpowers/systematic-debugging |
|
|
67
|
+
| 33 | Bug | `validate-fix` | Prove fix works: re-run suite, typecheck, lint | (dialogue, verify) | ✅ Active | superpowers/verification-before-completion |
|
|
68
|
+
| 34 | Review | `audit-code` | Self-review: CONVENTIONS.md compliance, SOLID, no `any`, test coverage | (checklist, pass/fail) | ✅ Active | superpowers/requesting-code-review + Clean Code |
|
|
69
|
+
| 35 | Review | `request-review` | Dispatch fresh reviewer agent (clean context, no shared state) | review-report (structured) | ✅ Active | original |
|
|
70
|
+
| 36 | Review | `respond-review` | Act on reviewer feedback: categorize (must/should), apply, verify | src/ (updated) | ✅ Active | superpowers/receiving-code-review |
|
|
71
|
+
| 37 | Review | `trace-requirement` | Link story IDs from RELEASE-PLAN.md to implementing code and tests | TRACEABILITY.md | ✅ Active | original |
|
|
72
|
+
| 38 | Integrate | `commit-message` | Draft Conventional Commits + semver prediction | (git message) | ✅ Active | mattpocock/skills (prepare-semantic-commit) |
|
|
73
|
+
| 39 | Integrate | `release-branch` | Merge/PR/keep/discard decision + worktree cleanup | (git PR created) | ✅ Active | superpowers/finishing-a-development-branch |
|
|
74
|
+
| 40 | Sustain | `inspect-quality` | Run structured QA session → BUG-LOG.md | BUG-LOG.md | ✅ Active | mattpocock/skills (qa, adapted: local-first) |
|
|
75
|
+
| 41 | Sustain | `organize-workspace` | Classify, show, confirm, then clean workspace | (filesystem state) | ✅ Active | mattpocock/skills (clean-my-room) |
|
|
76
|
+
| 42 | Utility | `terse-mode` | Fallback: ultra-terse output when context critically long | (prompt override) | ✅ Active | mattpocock/skills (caveman); fallback-only |
|
|
77
|
+
| 43 | Utility | `craft-skill` | Build a new bigpowers skill with proper structure | skills/<name>/SKILL.md | ✅ Active | superpowers/writing-skills + mattpocock/write-a-skill |
|
|
78
|
+
| 44 | Utility | `edit-document` | Edit and restructure a document in specs/ | specs/<name>.md | ✅ Active | mattpocock/skills (edit-article) |
|
|
79
|
+
| 45 | Utility | `session-state` | Track implementation decisions and progress in specs/STATE.md | STATE.md | ✅ Active | original |
|
|
80
|
+
| 46 | Utility | `migrate-spec` | Detect GSD/spec-kit/BMAD artifacts and transform to bigpowers specs/ format | specs/ (migrated artifacts) | ✅ Active | original v2.1.0 |
|
|
81
|
+
| 47 | Utility | `visual-dashboard` | Browser-based dashboard: architecture, plans, and UI mockups | (browser view) | ✅ Active | original |
|
|
82
|
+
| 48 | Utility | `write-document` | Write and sync high-integrity technical documents (BMAD methodology) | specs/<name>.md | ✅ Active | original |
|
|
83
|
+
| 49 | Utility | `setup-environment` | Pre-install deps, configure tools before work | (.env, installed packages) | 📋 Planned | autoresearch experiment |
|
|
84
|
+
| 50 | Utility | `reset-baseline` | Restore project to known state between runs | (clean working tree) | 📋 Planned | autoresearch experiment |
|
|
85
|
+
|
|
86
|
+
**Total: 50 rows — 44 ✅ Active, 6 📋 Planned.**
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Lifecycle Arc
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
[First time]
|
|
94
|
+
using-bigpowers → orchestrate-project (choose Standard / Fast-Track / Ad-Hoc)
|
|
95
|
+
↓
|
|
96
|
+
survey-context → elaborate-spec → map-codebase
|
|
97
|
+
↓
|
|
98
|
+
model-domain / define-language / grill-me / design-interface / deepen-architecture
|
|
99
|
+
↓
|
|
100
|
+
assess-impact → change-request → define-success → plan-work / plan-refactor / plan-release
|
|
101
|
+
↓
|
|
102
|
+
kickoff-branch → guard-git / hook-commits / seed-conventions
|
|
103
|
+
↓
|
|
104
|
+
[Unknown domain?] spike-prototype → (learnings feed back to plan-work)
|
|
105
|
+
↓
|
|
106
|
+
develop-tdd (+ enforce-first) ←→ delegate-task / dispatch-agents / execute-plan
|
|
107
|
+
↓
|
|
108
|
+
wire-observability (production-readiness gate, any phase)
|
|
109
|
+
↓
|
|
110
|
+
investigate-bug → validate-fix
|
|
111
|
+
↓
|
|
112
|
+
audit-code → request-review → respond-review → trace-requirement
|
|
113
|
+
↓
|
|
114
|
+
commit-message → release-branch
|
|
115
|
+
↓
|
|
116
|
+
inspect-quality → organize-workspace (ongoing)
|
|
117
|
+
|
|
118
|
+
Transversal utilities (any phase):
|
|
119
|
+
terse-mode, craft-skill, edit-document, session-state, migrate-spec, visual-dashboard, write-document
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Status Legend
|
|
125
|
+
|
|
126
|
+
| Icon | Meaning |
|
|
127
|
+
|---|---|
|
|
128
|
+
| ✅ Active | Implemented — SKILL.md exists, skill is usable |
|
|
129
|
+
| 📋 Planned | Designed or referenced, not yet implemented (no directory) |
|
|
130
|
+
| 🔄 Refactoring | Active but under revision |
|
|
131
|
+
| ⚠️ Deprecated | Will be removed in a future release |
|
|
132
|
+
|
|
133
|
+
## Naming Convention Notes
|
|
134
|
+
|
|
135
|
+
All skills follow `verb-noun` kebab-case (ADR-0001). Two documented exceptions:
|
|
136
|
+
- `terse-mode` — adjective-noun; retained for clarity (the verb form `enable-terse` is confusing)
|
|
137
|
+
- `visual-dashboard` — adjective-noun; retained for clarity (`view-dashboard` implies read-only)
|
|
138
|
+
|
|
139
|
+
## How to Update
|
|
140
|
+
|
|
141
|
+
1. Every new skill: add a row here before the skill is published.
|
|
142
|
+
2. Every rename: update the Skill column; add a note in the Added column.
|
|
143
|
+
3. Every phase change: update the Phase column.
|
|
144
|
+
4. After any change: bump the "Last updated" date and run `bash scripts/sync-skills.sh`.
|
|
145
|
+
|
|
146
|
+
→ verify: `find . -maxdepth 2 -name "SKILL.md" | grep -v ".git\|.cursor\|.gemini" | wc -l`
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: assess-impact
|
|
3
|
+
description: Analyze the blast radius of a proposed change before any code is written. Maps dependents, affected stories, and test coverage. Produces specs/IMPACT.md. Use before plan-work on any non-trivial change, when touching a shared module, or when the user asks "what does this break?".
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Assess Impact
|
|
7
|
+
|
|
8
|
+
> **HARD GATE** — Run this skill before `plan-work` whenever a change touches an existing module, symbol, or file used by more than one caller. Skip only for net-new code with no existing dependents.
|
|
9
|
+
|
|
10
|
+
Find the blast radius of the proposed change before a single line is written.
|
|
11
|
+
|
|
12
|
+
## Process
|
|
13
|
+
|
|
14
|
+
### 1. Identify the target
|
|
15
|
+
|
|
16
|
+
Name the symbol, module, or file being changed. If the user hasn't specified, ask one question: "What exactly are you changing?"
|
|
17
|
+
|
|
18
|
+
### 2. Find dependents
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
grep -rn "[symbol-name]" . --include="*.ts" | grep -v node_modules
|
|
22
|
+
git log --oneline -10 -- [file-path]
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
→ verify: `grep -rn "[target]" . | wc -l`
|
|
26
|
+
|
|
27
|
+
### 3. Map to release plan stories
|
|
28
|
+
|
|
29
|
+
Read `specs/RELEASE-PLAN.md` (if it exists). For each dependent found in Step 2, identify which story owns that module. List stories that will be affected by the change.
|
|
30
|
+
|
|
31
|
+
→ verify: `grep -c "Story" specs/RELEASE-PLAN.md 2>/dev/null || echo "no release plan"`
|
|
32
|
+
|
|
33
|
+
### 4. List test coverage
|
|
34
|
+
|
|
35
|
+
Find tests that exercise the target:
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
grep -rn "[symbol-name]" . --include="*.test.*" --include="*.spec.*"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
→ verify: `grep -rn "[target]" . --include="*.test.*" | wc -l`
|
|
42
|
+
|
|
43
|
+
### 5. Classify risk
|
|
44
|
+
|
|
45
|
+
| Level | Condition |
|
|
46
|
+
|-------|-----------|
|
|
47
|
+
| Low | ≤ 2 callers, all covered by tests |
|
|
48
|
+
| Medium | 3–10 callers, partial test coverage |
|
|
49
|
+
| High | > 10 callers, or shared API/interface, or no tests |
|
|
50
|
+
|
|
51
|
+
### 6. Write specs/IMPACT.md
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
## Target
|
|
55
|
+
[symbol or file being changed]
|
|
56
|
+
|
|
57
|
+
## Dependents ([count])
|
|
58
|
+
- [file]: [caller or usage]
|
|
59
|
+
|
|
60
|
+
## Affected Stories
|
|
61
|
+
- Story [X.Y]: [title]
|
|
62
|
+
|
|
63
|
+
## Test Coverage
|
|
64
|
+
- [test file]: covers [scenario]
|
|
65
|
+
- Gap: [untested behavior]
|
|
66
|
+
|
|
67
|
+
## Risk: Low / Medium / High
|
|
68
|
+
[One-sentence rationale]
|
|
69
|
+
|
|
70
|
+
## Recommended action
|
|
71
|
+
[Proceed / Add tests first / Discuss design]
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
→ verify: `grep "Risk:" specs/IMPACT.md`
|
|
75
|
+
|
|
76
|
+
Suggest `plan-work` once risk is understood and any test gaps are noted.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Clean Code Heuristics (Chapter 17)
|
|
2
|
+
|
|
3
|
+
A summary of Robert C. Martin's catalogue of code smells and heuristics, used as the technical benchmark for `audit-code`.
|
|
4
|
+
|
|
5
|
+
## Comments (C)
|
|
6
|
+
- **C1: Inappropriate Information**: Comments should only hold technical notes. Metadata (author, change history) belongs in Git.
|
|
7
|
+
- **C2: Obsolete Comment**: Update or delete comments that are no longer accurate.
|
|
8
|
+
- **C3: Redundant Comment**: Don't describe code that adequately describes itself (e.g., `i++; // increment i`).
|
|
9
|
+
- **C4: Poorly Written Comment**: If you write a comment, spend time making it the best it can be.
|
|
10
|
+
- **C5: Commented-Out Code**: Delete it. Git remembers it.
|
|
11
|
+
|
|
12
|
+
## Environment (E)
|
|
13
|
+
- **E1: Build Requires More Than One Step**: Building should be a single trivial operation (e.g., `bash install.sh`).
|
|
14
|
+
- **E2: Tests Require More Than One Step**: Running all tests should be one simple command (e.g., `npm test`).
|
|
15
|
+
|
|
16
|
+
## Functions (F)
|
|
17
|
+
- **F1: Too Many Arguments**: 0 is ideal, 1-2 is fine, 3 requires special justification. Never > 3.
|
|
18
|
+
- **F2: Output Arguments**: Avoid them. If a function changes state, it should change the state of its owning object.
|
|
19
|
+
- **F3: Flag Arguments**: Boolean arguments are a smell that the function does > 1 thing.
|
|
20
|
+
- **F4: Dead Function**: Discard methods that are never called.
|
|
21
|
+
|
|
22
|
+
## General (G)
|
|
23
|
+
- **G1: Multiple Languages in One Source File**: Try to minimize the mixing of languages (e.g., HTML inside Java).
|
|
24
|
+
- **G5: Duplication (DRY)**: **The root of all evil.** Every time you see duplication, it's a missed opportunity for abstraction.
|
|
25
|
+
- **G6: Code at Wrong Level of Abstraction**: High-level concepts in base classes; low-level details in derivatives.
|
|
26
|
+
- **G25: Replace Magic Numbers with Named Constants**: No "naked" numbers or strings.
|
|
27
|
+
- **G28: Encapsulate Conditionals**: Prefer `if (shouldBePublished())` over complex boolean logic.
|
|
28
|
+
- **G29: Avoid Negative Conditionals**: Prefer `if (buffer.shouldCompact())` over `if (!buffer.shouldNotCompact())`.
|
|
29
|
+
- **G30: Functions Should Do One Thing**: If a function can be split into sections, it's doing too much.
|
|
30
|
+
- **G31: Hidden Temporal Couplings**: If execution order matters, make the dependency explicit via arguments.
|
|
31
|
+
- **G34: Functions Should Descend Only One Level of Abstraction**: The Stepdown Rule.
|
|
32
|
+
|
|
33
|
+
## Naming (N)
|
|
34
|
+
- **N1: Choose Descriptive Names**: Names should reveal intent and be updated as code evolves.
|
|
35
|
+
- **N4: Unambiguous Names**: Names should make the working of a function/variable clear.
|
|
36
|
+
- **N7: Names Should Describe Side-Effects**: Describe everything the function is or does.
|
|
37
|
+
|
|
38
|
+
## Tests (T)
|
|
39
|
+
- **T1: Insufficient Tests**: A test suite should test everything that could possibly break.
|
|
40
|
+
- **T4: An Ignored Test Is a Question about an Ambiguity**: Document the reason for `@Ignore`.
|
|
41
|
+
- **T5: Test Boundary Conditions**: Most bugs happen at the boundaries; test them exhaustively.
|
|
42
|
+
- **T8: Test Coverage Patterns Can Be Revealing**: Analyze what code is *not* executed to find gaps.
|
|
43
|
+
- **T9: Tests Should Be Fast**: Slow tests don't get run.
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: audit-code
|
|
3
|
+
description: Self-review checklist for the coding agent to run before dispatching a reviewer. Checks CONVENTIONS.md compliance, Boy Scout Rule, test coverage, types, and SOLID. Produces a pass/fail checklist. Use before request-review, before committing, or when user asks for a code quality check.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Audit Code
|
|
7
|
+
|
|
8
|
+
Run this self-review before asking anyone else to look at the code. The goal is to catch everything that is clearly wrong or missing — so the reviewer can focus on design and architecture, not hygiene.
|
|
9
|
+
|
|
10
|
+
**Distinct from `request-review`:** This is the coding agent checking its own work. No second agent is involved. Run this first; run `request-review` after this passes.
|
|
11
|
+
|
|
12
|
+
## Checklist
|
|
13
|
+
|
|
14
|
+
### CONVENTIONS.md Compliance
|
|
15
|
+
|
|
16
|
+
- [ ] All output files are in `specs/` (no docs written to project root)
|
|
17
|
+
- [ ] No `gh issue create` calls anywhere in new/modified skills or scripts
|
|
18
|
+
- [ ] `gh` used only for PRs and repo clone operations
|
|
19
|
+
- [ ] No GitHub REST API called directly (no curl/fetch to api.github.com)
|
|
20
|
+
|
|
21
|
+
### Scope
|
|
22
|
+
|
|
23
|
+
- [ ] Changes are limited to what was asked — nothing extra refactored or reorganized
|
|
24
|
+
- [ ] No speculative features added
|
|
25
|
+
- [ ] No files touched outside the stated scope
|
|
26
|
+
- [ ] Changes are surgical: only code strictly required for the task; no refactoring, reorganization, or cleanup outside task scope (Boy Scout Rule applied surgically, not broadly)
|
|
27
|
+
|
|
28
|
+
### Boy Scout Rule
|
|
29
|
+
|
|
30
|
+
- [ ] Every file I touched is cleaner than when I found it
|
|
31
|
+
- [ ] No dead code left behind
|
|
32
|
+
- [ ] No commented-out code blocks
|
|
33
|
+
|
|
34
|
+
### Types and Safety
|
|
35
|
+
|
|
36
|
+
- [ ] No `any` types introduced (TypeScript) or untyped public functions (Python/Go/etc.)
|
|
37
|
+
- [ ] No `@ts-ignore` or `// eslint-disable` added
|
|
38
|
+
- [ ] No `as unknown as X` casts that bypass type safety
|
|
39
|
+
|
|
40
|
+
### Test Coverage
|
|
41
|
+
|
|
42
|
+
- [ ] Every new function has at least one test
|
|
43
|
+
- [ ] Every bug fix has a regression test
|
|
44
|
+
- [ ] Tests verify behavior through public interfaces (not implementation details)
|
|
45
|
+
- [ ] Tests are F.I.R.S.T compliant (use `enforce-first` if unsure)
|
|
46
|
+
|
|
47
|
+
### SOLID and Heuristics
|
|
48
|
+
|
|
49
|
+
- [ ] Single Responsibility: no function or module doing two unrelated things
|
|
50
|
+
- [ ] Open/Closed: extended through interfaces, not by modifying stable code
|
|
51
|
+
- [ ] Dependency Inversion: dependencies injected, not imported globally where avoidable
|
|
52
|
+
- [ ] **Chapter 17 Heuristics**: Code is free of smells documented in `audit-code/HEURISTICS.md` (G, N, C, T)
|
|
53
|
+
|
|
54
|
+
### Code Style (CONVENTIONS.md)
|
|
55
|
+
|
|
56
|
+
- [ ] Functions: 4–20 lines; split if longer
|
|
57
|
+
- [ ] Functions: descend exactly one level of abstraction (The Stepdown Rule / G34)
|
|
58
|
+
- [ ] Files: under 300 lines (ideally 200–300)
|
|
59
|
+
- [ ] Names: specific and unique (grep returns < 5 hits for each name)
|
|
60
|
+
- [ ] No duplication — shared logic extracted (DRY / G5)
|
|
61
|
+
- [ ] Early returns over nested ifs; max 2 levels of indentation
|
|
62
|
+
- [ ] Conditionals: expressed as positives (G29)
|
|
63
|
+
- [ ] Comments explain WHY, not WHAT
|
|
64
|
+
|
|
65
|
+
### Agent Readability (Akita's Lens)
|
|
66
|
+
|
|
67
|
+
- [ ] Functions are small enough to fit in a standard context window (4–20 lines)
|
|
68
|
+
- [ ] Names are unique and specific enough to be `grep`-able (grep returns < 5 hits)
|
|
69
|
+
- [ ] Types are explicit (no `any`, no inferred return types for public APIs)
|
|
70
|
+
- [ ] Code avoids deep nesting (max 2 levels) and uses early returns
|
|
71
|
+
|
|
72
|
+
### Red Flags
|
|
73
|
+
|
|
74
|
+
Before reporting, name any rationalization you caught yourself making for skipping a checklist item. Silence is not acceptable — if you skipped an item, state the reason explicitly.
|
|
75
|
+
|
|
76
|
+
## Output
|
|
77
|
+
|
|
78
|
+
Report the checklist with ✓ / ✗ per item. For each ✗, describe what needs to be fixed.
|
|
79
|
+
|
|
80
|
+
If all items pass: suggest running `request-review` for an independent second opinion.
|
|
81
|
+
If any items fail: fix them before proceeding.
|
package/bin/bigpowers.js
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const { execSync } = require('child_process');
|
|
4
|
+
const path = require('path');
|
|
5
|
+
|
|
6
|
+
console.log('🚀 bigpowers — setting up...\n');
|
|
7
|
+
|
|
8
|
+
try {
|
|
9
|
+
const rootDir = path.dirname(path.dirname(__filename));
|
|
10
|
+
|
|
11
|
+
console.log('Syncing skills...');
|
|
12
|
+
execSync('bash scripts/sync-skills.sh', {
|
|
13
|
+
cwd: rootDir,
|
|
14
|
+
stdio: 'inherit'
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
console.log('\nRunning installation...');
|
|
18
|
+
execSync('bash scripts/install.sh', {
|
|
19
|
+
cwd: rootDir,
|
|
20
|
+
stdio: 'inherit'
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
console.log('\n✅ bigpowers setup complete!\n');
|
|
24
|
+
} catch (error) {
|
|
25
|
+
console.error('\n❌ Setup failed:', error.message);
|
|
26
|
+
process.exit(1);
|
|
27
|
+
}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# WSJF Scoring Reference
|
|
2
|
+
|
|
3
|
+
Weighted Shortest Job First: **WSJF = (Business Value + Time Criticality + Risk Reduction) / Job Size**
|
|
4
|
+
|
|
5
|
+
All dimensions scored 1–10 using a Fibonacci-like scale: 1, 2, 3, 5, 8, 10.
|
|
6
|
+
|
|
7
|
+
## Business Value
|
|
8
|
+
|
|
9
|
+
| Score | Meaning |
|
|
10
|
+
|-------|---------|
|
|
11
|
+
| 10 | Core revenue path, legal requirement, blocking launch |
|
|
12
|
+
| 8 | Significant user value, major pain point removed |
|
|
13
|
+
| 5 | Notable improvement, medium user segment affected |
|
|
14
|
+
| 3 | Nice-to-have, minor convenience |
|
|
15
|
+
| 1 | Cosmetic or speculative |
|
|
16
|
+
|
|
17
|
+
## Time Criticality
|
|
18
|
+
|
|
19
|
+
| Score | Meaning |
|
|
20
|
+
|-------|---------|
|
|
21
|
+
| 10 | Hard deadline (regulatory, contract, launch date) |
|
|
22
|
+
| 8 | Competitive window closing, partner dependency |
|
|
23
|
+
| 5 | Would delay next milestone if deferred |
|
|
24
|
+
| 3 | Flexible, can slip one sprint |
|
|
25
|
+
| 1 | No urgency |
|
|
26
|
+
|
|
27
|
+
## Risk Reduction (or Opportunity Enablement)
|
|
28
|
+
|
|
29
|
+
| Score | Meaning |
|
|
30
|
+
|-------|---------|
|
|
31
|
+
| 10 | Eliminates critical architectural risk or enables a new capability |
|
|
32
|
+
| 8 | Reduces a known failure mode or unblocks high-value work |
|
|
33
|
+
| 5 | Moderate risk mitigation or enablement |
|
|
34
|
+
| 3 | Low risk reduction |
|
|
35
|
+
| 1 | No risk relevance |
|
|
36
|
+
|
|
37
|
+
## Job Size (effort denominator — larger = lower WSJF)
|
|
38
|
+
|
|
39
|
+
| Score | Meaning |
|
|
40
|
+
|-------|---------|
|
|
41
|
+
| 1 | Hours |
|
|
42
|
+
| 2 | 1 day |
|
|
43
|
+
| 3 | 2–3 days |
|
|
44
|
+
| 5 | 1 week |
|
|
45
|
+
| 8 | 2 weeks |
|
|
46
|
+
| 10 | 1 month+ |
|
|
47
|
+
|
|
48
|
+
## Cut threshold
|
|
49
|
+
|
|
50
|
+
Stories with WSJF < 1.5 are cut candidates: high effort, low combined value.
|
|
51
|
+
|
|
52
|
+
## Example
|
|
53
|
+
|
|
54
|
+
Story: "Add OAuth login"
|
|
55
|
+
- Business Value: 8 (removes major sign-up friction)
|
|
56
|
+
- Time Criticality: 5 (Q3 launch nice, not hard)
|
|
57
|
+
- Risk Reduction: 3 (minor security improvement)
|
|
58
|
+
- Job Size: 5 (one week)
|
|
59
|
+
|
|
60
|
+
WSJF = (8 + 5 + 3) / 5 = **3.2** — healthy, implement early.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: change-request
|
|
3
|
+
description: Add a new requirement or reorder epics by WSJF value engineering against specs/RELEASE-PLAN.md. Two modes: Add (intake a new requirement mid-flight) and Reorder (re-score and re-sort all epics/stories). Use when a new requirement arrives mid-release, or when the plan needs prioritization.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Change Request
|
|
7
|
+
|
|
8
|
+
> **HARD GATE** — `specs/RELEASE-PLAN.md` must exist before running either mode. If it doesn't, run `plan-release` first.
|
|
9
|
+
>
|
|
10
|
+
> → verify: `[ -f specs/RELEASE-PLAN.md ] && echo "ready" || echo "BLOCKED: run plan-release first"`
|
|
11
|
+
|
|
12
|
+
Two modes. State which one you want or the skill will ask.
|
|
13
|
+
|
|
14
|
+
## Mode A — Add
|
|
15
|
+
|
|
16
|
+
Intake a new requirement mid-flight without disrupting work in progress.
|
|
17
|
+
|
|
18
|
+
1. **Capture**: What is the change? What problem does it solve?
|
|
19
|
+
2. **Locate**: Which existing stories does it affect or replace?
|
|
20
|
+
3. **Draft**: Write the new story in RELEASE-PLAN.md format (with Gherkin AC and tasks + verify commands).
|
|
21
|
+
4. **Place**: Append as a new story under an existing epic, or open a new epic if needed.
|
|
22
|
+
5. **Score**: Compute WSJF score for the new story; note if it outranks in-progress work.
|
|
23
|
+
|
|
24
|
+
→ verify: `grep -c "Story" specs/RELEASE-PLAN.md`
|
|
25
|
+
|
|
26
|
+
## Mode B — Reorder
|
|
27
|
+
|
|
28
|
+
Value-engineering pass over the full release plan using WSJF.
|
|
29
|
+
|
|
30
|
+
See [REFERENCE.md](REFERENCE.md) for the full WSJF scoring rubric.
|
|
31
|
+
|
|
32
|
+
1. **Score** each epic/story: Business Value (1–10) + Time Criticality (1–10) + Risk Reduction (1–10) / Job Size (1–10).
|
|
33
|
+
2. **Re-sort** epics and stories by WSJF score descending.
|
|
34
|
+
3. **Flag cut candidates**: stories where Effort is L and Value is Low (WSJF < 1.5).
|
|
35
|
+
4. **Update** `specs/RELEASE-PLAN.md` — add WSJF scores, new order, short rationale for any reordering.
|
|
36
|
+
5. **Report** the delta: what moved up, what moved down, what is a cut candidate.
|
|
37
|
+
|
|
38
|
+
→ verify: `grep -c "WSJF:" specs/RELEASE-PLAN.md`
|
|
39
|
+
|
|
40
|
+
## After either mode
|
|
41
|
+
|
|
42
|
+
Suggest `plan-work` for the top-ranked unstarted story.
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Conventional Commits + semantic-style release (reference)
|
|
2
|
+
|
|
3
|
+
## Message format
|
|
4
|
+
|
|
5
|
+
From [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/#specification):
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
<type>[optional scope][optional !]: <description>
|
|
9
|
+
|
|
10
|
+
[optional body]
|
|
11
|
+
|
|
12
|
+
[optional footer(s)]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
- **Scope:** parenthesized noun, e.g. `feat(parser): …`.
|
|
16
|
+
- **Breaking:** `!` before `:` (e.g. `feat(api)!: …`) and/or footer `BREAKING CHANGE: description` (token must be uppercase per spec for that footer name).
|
|
17
|
+
- **Description:** short summary; body explains *why* or migration steps.
|
|
18
|
+
|
|
19
|
+
Common **types** (not exhaustive): `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore` — as in [Angular / commitlint conventions](https://github.com/conventional-changelog/commitlint).
|
|
20
|
+
|
|
21
|
+
## Advanced Specification Patterns
|
|
22
|
+
|
|
23
|
+
### Reverts
|
|
24
|
+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`.
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
revert: feat(api): add user endpoint
|
|
28
|
+
|
|
29
|
+
This reverts commit 676104e.
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Breaking Changes
|
|
33
|
+
A breaking change can be signaled by:
|
|
34
|
+
1. A **`BREAKING CHANGE:`** footer (must be uppercase, at the start of the footer). This is the **most compatible** way to trigger a Major release in `semantic-release` (Angular preset).
|
|
35
|
+
2. A **`!`** after the type/scope: `feat(api)!: change user response shape`.
|
|
36
|
+
|
|
37
|
+
**Pro-tip:** For maximum compatibility with all tooling (older and newer), use BOTH the `!` and the `BREAKING CHANGE:` footer.
|
|
38
|
+
|
|
39
|
+
### Footers (Tokens & Values)
|
|
40
|
+
Footers follow the same `Token: value` pattern as Git Trailers. Common tokens:
|
|
41
|
+
- `Refs: #123`
|
|
42
|
+
- `See-also: docs/ADR-001.md`
|
|
43
|
+
- `Signed-off-by: Name <email>`
|
|
44
|
+
|
|
45
|
+
**Multi-line footers:** If a footer value spans multiple lines, each subsequent line must be indented.
|
|
46
|
+
|
|
47
|
+
### Squashing & History
|
|
48
|
+
When using `gh pr merge --squash`, the PR title is usually used as the commit subject.
|
|
49
|
+
- **PR Title:** MUST follow `<type>(<scope>): <description>`
|
|
50
|
+
- **PR Body:** Content will be moved to the commit body.
|
|
51
|
+
|
|
52
|
+
## Release Type Mapping (Default Angular Preset)
|
|
53
|
+
|
|
54
|
+
This table reflects the **out-of-the-box** behavior of `semantic-release` using the `@semantic-release/commit-analyzer` default (Angular) rules.
|
|
55
|
+
|
|
56
|
+
| Commit pattern | Release | Notes |
|
|
57
|
+
|----------------|---------|-------|
|
|
58
|
+
| `fix:` | **Patch** | Bug fixes |
|
|
59
|
+
| `feat:` | **Minor** | New features |
|
|
60
|
+
| `perf:` | **Patch** | Performance improvements |
|
|
61
|
+
| `any type` + `BREAKING CHANGE:` footer | **Major** | **Mandatory** for Major version bumps in default configs. |
|
|
62
|
+
| `any type!:` (exclamation mark) | **Major** | Supported by modern CC parsers, but use footer for max safety. |
|
|
63
|
+
| `docs:`, `chore:`, `test:`, `ci:`, `refactor:`, `style:` | **None** | Does not trigger a new release by default. |
|
|
64
|
+
|
|
65
|
+
> **Warning:** While `refactor:` and `style:` improve code, they do NOT trigger a release in the default Angular preset. Use `fix:` if a refactor also fixes a bug, or `feat:` if it adds new behavior.
|
|
66
|
+
|
|
67
|
+
## Custom Repositories
|
|
68
|
+
|
|
69
|
+
- Read `release.config.js`, `.releaserc`, or `package.json` → `release` / `semantic-release` config.
|
|
70
|
+
- The **@semantic-release/commit-analyzer** preset may map types differently; prefer **their** rules when they conflict with this reference.
|
|
71
|
+
|
|
72
|
+
## Squash and PR titles
|
|
73
|
+
|
|
74
|
+
- If the team squashes on merge, the **PR title** often becomes the single squashed commit subject — it should still follow `type(scope): description` for tooling.
|
|
75
|
+
- `revert:` type and `Refs:` footers are valid patterns; revert handling varies by [tooling](https://www.conventionalcommits.org/en/v1.0.0/#specification).
|
|
76
|
+
|
|
77
|
+
## Links
|
|
78
|
+
|
|
79
|
+
- [Conventional Commits — specification](https://www.conventionalcommits.org/en/v1.0.0/#specification)
|
|
80
|
+
- [semantic-release — README (commit format & flow)](https://github.com/semantic-release/semantic-release#commit-message-format)
|
|
81
|
+
- Fork pointer: [semantic-release-baby](https://github.com/danielvm-git/semantic-release-baby) (automation and docs align with upstream semantic-release)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: commit-message
|
|
3
|
+
description: Reviews working-tree changes, then drafts a Conventional Commits title/body and states the semantic-release version bump a single such commit would imply. Also notes which defensive-code categories were touched. Use when the user wants to commit recent work, prepare a Conventional Commits message, or asks for semantic-release / semver-consistent messaging before git commit.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Commit Message
|
|
7
|
+
|
|
8
|
+
## What "last chat" means
|
|
9
|
+
|
|
10
|
+
- **Primary source of truth:** `git status`, `git diff` (unstaged), and `git diff --cached` (staged). Run these in the repo root (or the paths the user changed).
|
|
11
|
+
- **Context:** use the current conversation to summarize *intent* and to spot **breaking** API/behavior changes that diff alone may not show.
|
|
12
|
+
- If the user tracks a session baseline (e.g. branch, tag, or `git stash create` at start), you may `git diff <baseline>..HEAD` plus uncommitted diffs; otherwise use only the index and working tree.
|
|
13
|
+
|
|
14
|
+
## Quick workflow
|
|
15
|
+
|
|
16
|
+
1. **Inventory** — List changed paths; group by feature vs chore vs docs vs test-only.
|
|
17
|
+
2. **Decide commit shape** — One atomic commit is ideal. If the diff mixes unrelated concerns, recommend **multiple commits** (each with its own type/scope) before suggesting one message.
|
|
18
|
+
3. **Classify for semantic release** — `fix` → patch, `feat` → minor, **breaking** → major.
|
|
19
|
+
4. **Write the message** — `type(optional-scope)!: description` (see [REFERENCE.md](REFERENCE.md#message-format)). Use `!` or a `BREAKING CHANGE:` footer when behavior contracts change.
|
|
20
|
+
5. **Note defensive-code categories touched** — from CONVENTIONS.md: Rate limit | Retry with backoff | Circuit breaker | Timeout | Graceful degradation
|
|
21
|
+
6. **Deliver** — Output:
|
|
22
|
+
- Proposed **full commit message** (title + optional body + footers).
|
|
23
|
+
- **Release bump** this commit would drive: `patch` | `minor` | `major` | `none`.
|
|
24
|
+
- Optional `git add …` and `git commit -m` instructions; do **not** run destructive git commands unless the user asked.
|
|
25
|
+
|
|
26
|
+
## Checklist before finalizing
|
|
27
|
+
|
|
28
|
+
- [ ] Type matches the **dominant** user-visible outcome (`feat` vs `fix` vs `perf`, etc.).
|
|
29
|
+
- [ ] **Scope** is a short noun in parentheses if it helps (e.g. `fix(api): …`).
|
|
30
|
+
- [ ] Breaking changes are explicit (`!` and/or `BREAKING CHANGE:` in the body/footer).
|
|
31
|
+
- [ ] Description is imperative, lowercase start after the prefix, no trailing period in the title line.
|
|
32
|
+
|
|
33
|
+
## When not to invent a bump
|
|
34
|
+
|
|
35
|
+
If the repo uses a custom `@semantic-release/commit-analyzer` preset, note that your bump is **heuristic** and they should match `.releaserc` / `release.config.*`. See [REFERENCE.md](REFERENCE.md#custom-repositories).
|
|
36
|
+
|
|
37
|
+
## Further reading
|
|
38
|
+
|
|
39
|
+
- [REFERENCE.md](REFERENCE.md) — Message shape, footers, release mapping, squashing notes.
|