liteagents 3.0.0 → 3.6.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/CHANGELOG.md +158 -1
- package/README.md +113 -169
- package/installer/cli.js +4 -2
- package/installer/package-manager.js +3 -1
- package/package.json +4 -3
- package/packages/ampcode/AGENT.md +10 -18
- package/packages/ampcode/agents/code-developer.md +11 -17
- package/packages/ampcode/agents/orchestrator.md +1 -1
- package/packages/ampcode/agents/quality-assurance.md +3 -1
- package/packages/ampcode/{commands/brainstorming.md → skills/brainstorming/SKILL.md} +2 -3
- package/packages/ampcode/{commands/branch-review.md → skills/branch-review/SKILL.md} +27 -13
- package/packages/{claude/commands/docs-builder.md → ampcode/skills/docs-builder/SKILL.md} +1 -1
- package/packages/ampcode/{commands/live-canvas.md → skills/live-canvas/SKILL.md} +8 -4
- package/packages/ampcode/{commands/refactor.md → skills/refactor/SKILL.md} +49 -7
- package/packages/ampcode/{commands/release.md → skills/release/SKILL.md} +4 -4
- package/packages/{claude/commands → ampcode/skills}/remember/AGENT_RULES.md +44 -84
- package/packages/ampcode/{commands/remember.md → skills/remember/SKILL.md} +11 -6
- package/packages/ampcode/{commands → skills}/remember/friction.cjs +0 -0
- package/packages/ampcode/{commands → skills}/remember/stub-check.cjs +28 -19
- package/packages/ampcode/{commands → skills}/remember/sync-rules.cjs +28 -19
- package/packages/{claude/commands → ampcode/skills}/remember/version-check.cjs +1 -1
- package/packages/ampcode/skills/root-cause/SKILL.md +220 -0
- package/packages/ampcode/{commands/trace-back → skills/root-cause}/find-polluter.sh +0 -0
- package/packages/{claude/commands/security.md → ampcode/skills/security/SKILL.md} +1 -1
- package/packages/{claude/commands/ship.md → ampcode/skills/ship/SKILL.md} +1 -1
- package/packages/ampcode/skills/skill-creator/LICENSE.txt +202 -0
- package/packages/ampcode/{commands/skill-creator.md → skills/skill-creator/SKILL.md} +1 -2
- package/packages/ampcode/{commands → skills}/skill-creator/scripts/init_skill.py +0 -0
- package/packages/ampcode/{commands → skills}/skill-creator/scripts/package_skill.py +0 -0
- package/packages/ampcode/{commands → skills}/skill-creator/scripts/quick_validate.py +0 -0
- package/packages/ampcode/{commands/stash.md → skills/stash/SKILL.md} +2 -1
- package/packages/{claude/commands/test-generate.md → ampcode/skills/test-generate/SKILL.md} +2 -2
- package/packages/ampcode/variants.json +2 -2
- package/packages/claude/CLAUDE.md +10 -17
- package/packages/claude/agents/code-developer.md +11 -17
- package/packages/claude/agents/orchestrator.md +2 -3
- package/packages/claude/agents/quality-assurance.md +3 -1
- package/packages/claude/skills/brainstorming/SKILL.md +1 -2
- package/packages/claude/{commands/branch-review.md → skills/branch-review/SKILL.md} +15 -1
- package/packages/{ampcode/commands/docs-builder.md → claude/skills/docs-builder/SKILL.md} +7 -7
- package/packages/claude/skills/live-canvas/SKILL.md +5 -1
- package/packages/claude/{commands/refactor.md → skills/refactor/SKILL.md} +45 -3
- package/packages/claude/{commands/release.md → skills/release/SKILL.md} +1 -1
- package/packages/{ampcode/commands → claude/skills}/remember/AGENT_RULES.md +38 -78
- package/packages/claude/{commands/remember.md → skills/remember/SKILL.md} +11 -6
- package/packages/claude/{commands → skills}/remember/friction.cjs +0 -0
- package/packages/claude/{commands → skills}/remember/stub-check.cjs +28 -19
- package/packages/claude/{commands → skills}/remember/sync-rules.cjs +28 -19
- package/packages/{ampcode/commands → claude/skills}/remember/version-check.cjs +3 -3
- package/packages/claude/skills/root-cause/SKILL.md +220 -0
- package/packages/{ampcode/commands/security.md → claude/skills/security/SKILL.md} +2 -2
- package/packages/{ampcode/commands/ship.md → claude/skills/ship/SKILL.md} +2 -2
- package/packages/claude/skills/skill-creator/SKILL.md +1 -2
- package/packages/claude/{commands/stash.md → skills/stash/SKILL.md} +2 -1
- package/packages/{ampcode/commands/test-generate.md → claude/skills/test-generate/SKILL.md} +3 -3
- package/packages/claude/variants.json +1 -2
- package/packages/droid/AGENTS.md +10 -15
- package/packages/droid/commands/brainstorming.md +1 -4
- package/packages/droid/commands/branch-review.md +25 -14
- package/packages/droid/commands/docs-builder.md +0 -3
- package/packages/droid/commands/live-canvas.md +7 -5
- package/packages/droid/commands/refactor.md +47 -8
- package/packages/droid/commands/release.md +2 -5
- package/packages/droid/commands/remember/AGENT_RULES.md +38 -78
- package/packages/droid/commands/remember/stub-check.cjs +28 -19
- package/packages/droid/commands/remember/sync-rules.cjs +28 -19
- package/packages/droid/commands/remember/version-check.cjs +1 -1
- package/packages/droid/commands/remember.md +6 -4
- package/packages/droid/commands/root-cause.md +218 -0
- package/packages/droid/commands/security.md +0 -3
- package/packages/droid/commands/ship.md +0 -3
- package/packages/droid/commands/skill-creator/LICENSE.txt +202 -0
- package/packages/droid/commands/skill-creator.md +0 -4
- package/packages/droid/commands/stash.md +0 -2
- package/packages/droid/commands/test-generate.md +1 -4
- package/packages/droid/droids/1-create-prd.md +6 -2
- package/packages/droid/droids/2-generate-tasks.md +1 -2
- package/packages/droid/droids/3-process-task-list.md +1 -2
- package/packages/droid/droids/code-developer.md +12 -19
- package/packages/droid/droids/feature-planner.md +1 -2
- package/packages/droid/droids/market-researcher.md +1 -2
- package/packages/droid/droids/orchestrator.md +1 -2
- package/packages/droid/droids/quality-assurance.md +4 -3
- package/packages/droid/droids/system-architect.md +1 -2
- package/packages/droid/droids/ui-designer.md +1 -2
- package/packages/opencode/AGENTS.md +10 -15
- package/packages/opencode/agent/code-developer.md +11 -17
- package/packages/opencode/agent/quality-assurance.md +3 -1
- package/packages/opencode/command/brainstorming.md +1 -4
- package/packages/opencode/command/branch-review.md +25 -15
- package/packages/opencode/command/docs-builder.md +0 -4
- package/packages/opencode/command/live-canvas.md +7 -5
- package/packages/opencode/command/refactor.md +47 -9
- package/packages/opencode/command/release.md +2 -5
- package/packages/opencode/command/remember/AGENT_RULES.md +38 -78
- package/packages/opencode/command/remember/stub-check.cjs +28 -19
- package/packages/opencode/command/remember/sync-rules.cjs +28 -19
- package/packages/opencode/command/remember/version-check.cjs +1 -1
- package/packages/opencode/command/remember.md +6 -4
- package/packages/opencode/command/root-cause.md +218 -0
- package/packages/opencode/command/security.md +0 -4
- package/packages/opencode/command/ship.md +0 -3
- package/packages/opencode/command/skill-creator/LICENSE.txt +202 -0
- package/packages/opencode/command/skill-creator.md +0 -4
- package/packages/opencode/command/stash.md +0 -3
- package/packages/opencode/command/test-generate.md +1 -5
- package/packages/opencode/opencode.jsonc +4 -24
- package/packages/subagentic-manual.md +147 -314
- package/tools/ampcode/manifest-template.json +0 -1
- package/tools/claude/manifest-template.json +0 -1
- package/tools/droid/manifest-template.json +0 -1
- package/tools/opencode/manifest-template.json +0 -1
- package/packages/ampcode/commands/debug-method.md +0 -297
- package/packages/ampcode/commands/live-canvas/README.md +0 -264
- package/packages/ampcode/commands/optimize.md +0 -61
- package/packages/ampcode/commands/tdd-flow.md +0 -390
- package/packages/ampcode/commands/test-traps/example.ts +0 -158
- package/packages/ampcode/commands/test-traps.md +0 -378
- package/packages/ampcode/commands/trace-back.md +0 -176
- package/packages/ampcode/commands/verify-done.md +0 -152
- package/packages/claude/commands/optimize.md +0 -61
- package/packages/claude/plugins/live-canvas-marketplace/plugins/live-canvas-channel/README.md +0 -89
- package/packages/claude/skills/debug-method/CREATION-LOG.md +0 -119
- package/packages/claude/skills/debug-method/SKILL.md +0 -296
- package/packages/claude/skills/debug-method/test-academic.md +0 -14
- package/packages/claude/skills/debug-method/test-pressure-1.md +0 -58
- package/packages/claude/skills/debug-method/test-pressure-2.md +0 -68
- package/packages/claude/skills/debug-method/test-pressure-3.md +0 -69
- package/packages/claude/skills/live-canvas/README.md +0 -269
- package/packages/claude/skills/tdd-flow/SKILL.md +0 -392
- package/packages/claude/skills/test-traps/SKILL.md +0 -378
- package/packages/claude/skills/test-traps/example.ts +0 -158
- package/packages/claude/skills/trace-back/SKILL.md +0 -176
- package/packages/claude/skills/verify-done/SKILL.md +0 -152
- package/packages/droid/commands/debug-method.md +0 -297
- package/packages/droid/commands/live-canvas/README.md +0 -264
- package/packages/droid/commands/optimize.md +0 -61
- package/packages/droid/commands/tdd-flow.md +0 -390
- package/packages/droid/commands/test-traps/example.ts +0 -158
- package/packages/droid/commands/test-traps.md +0 -378
- package/packages/droid/commands/trace-back.md +0 -176
- package/packages/droid/commands/verify-done.md +0 -152
- package/packages/opencode/command/debug-method.md +0 -297
- package/packages/opencode/command/live-canvas/README.md +0 -264
- package/packages/opencode/command/optimize.md +0 -61
- package/packages/opencode/command/tdd-flow.md +0 -390
- package/packages/opencode/command/test-traps/example.ts +0 -158
- package/packages/opencode/command/test-traps.md +0 -378
- package/packages/opencode/command/trace-back.md +0 -176
- package/packages/opencode/command/verify-done.md +0 -152
- /package/packages/ampcode/{commands → skills}/docs-builder/docs-builder.cjs +0 -0
- /package/packages/ampcode/{commands → skills}/live-canvas/DESIGN_PRINCIPLES.md +0 -0
- /package/packages/ampcode/{commands → skills}/live-canvas/dev/post-variants.html +0 -0
- /package/packages/ampcode/{commands → skills}/live-canvas/templates/lab-banner.html +0 -0
- /package/packages/ampcode/{commands → skills}/live-canvas/templates/overlay-vanilla.js +0 -0
- /package/packages/claude/{commands → skills}/docs-builder/docs-builder.cjs +0 -0
- /package/packages/claude/skills/{trace-back → root-cause}/find-polluter.sh +0 -0
- /package/packages/droid/commands/{trace-back → root-cause}/find-polluter.sh +0 -0
- /package/packages/opencode/command/{trace-back → root-cause}/find-polluter.sh +0 -0
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: system-architect
|
|
3
|
-
description: Design MVP-first architectures with opensource preference
|
|
4
|
-
when_to_use: Use for system design, HLA/HLD creation, technology selection, and architecture validation from epics, user stories, or PRDs
|
|
3
|
+
description: Design MVP-first architectures with opensource preference. Use for system design, HLA/HLD creation, technology selection, and architecture validation from epics, user stories, or PRDs
|
|
5
4
|
model: inherit
|
|
6
5
|
tools: ["Read", "LS", "Grep", "Glob", "Create", "Edit", "MultiEdit", "ApplyPatch", "Execute", "WebSearch", "FetchUrl", "mcp"]
|
|
7
6
|
---
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ui-designer
|
|
3
|
-
description: Design lightweight, functional UI with simplified flows
|
|
4
|
-
when_to_use: Use for UI/UX design, user journeys, low-fidelity mockups, flow simplification, and framework selection
|
|
3
|
+
description: Design lightweight, functional UI with simplified flows. Use for UI/UX design, user journeys, low-fidelity mockups, flow simplification, and framework selection
|
|
5
4
|
model: inherit
|
|
6
5
|
tools: ["Read", "LS", "Grep", "Glob", "Create", "Edit", "MultiEdit", "ApplyPatch", "Execute", "WebSearch", "FetchUrl", "mcp"]
|
|
7
6
|
---
|
|
@@ -21,28 +21,23 @@ These subagents are available when using Claude Code CLI. Opencode can reference
|
|
|
21
21
|
| system-architect | Architect | Use for system design, architecture documents, technology selection, API design, and infrastructure planning |
|
|
22
22
|
| ui-designer | UX Expert | Use for UI/UX design, wireframes, prototypes, front-end specifications, and user experience optimization |
|
|
23
23
|
|
|
24
|
-
## Opencode Commands (
|
|
25
|
-
|
|
26
|
-
| ID | Description | Usage |
|
|
27
|
-
|
|
28
|
-
| brainstorming | Refines rough ideas into fully-formed designs through collaborative questioning | /brainstorming <session-type> <topic> |
|
|
29
|
-
| docs-builder | Reorg a docs corpus, split an oversized doc, search it, keep pages current, index them | /docs-builder [reorg \| cleanup <file.md>] |
|
|
30
|
-
| live-canvas | Design UI variations and collect click-to-annotate feedback from the browser (batch mode only on Opencode) | /live-canvas |
|
|
31
|
-
|
|
|
32
|
-
| refactor | Refactor code while maintaining behavior and tests | /refactor <code-section> | - |
|
|
24
|
+
## Opencode Commands (13 total)
|
|
25
|
+
|
|
26
|
+
| ID | Description | Usage |
|
|
27
|
+
|---|---|---|
|
|
28
|
+
| brainstorming | Refines rough ideas into fully-formed designs through collaborative questioning | /brainstorming <session-type> <topic> |
|
|
29
|
+
| docs-builder | Reorg a docs corpus, split an oversized doc, search it, keep pages current, index them | /docs-builder [reorg \| cleanup <file.md>] |
|
|
30
|
+
| live-canvas | Design UI variations and collect click-to-annotate feedback from the browser (batch mode only on Opencode) | /live-canvas |
|
|
31
|
+
| refactor | Refactor and optimize code while maintaining behavior and tests | /refactor <code-section> | - |
|
|
33
32
|
| remember | Consolidate stashes + friction into project memory | /remember | - |
|
|
34
33
|
| branch-review | Pre-merge review: general review + full security audit, verify pass, no fixes | /branch-review [target] [level] | - |
|
|
35
|
-
|
|
|
34
|
+
| root-cause | Find the cause before changing code - evidence, backward trace, one hypothesis, fix at the source | /root-cause <bug-or-error-description> |
|
|
36
35
|
| security | Security audit — recurring six, injection, auth, trust boundaries; reports, never fixes | /security [target] | - |
|
|
37
36
|
| ship | Mechanical pre-deploy gate — tests, build, tree state | /ship | - |
|
|
38
37
|
| release | Verify, sweep docs, cut a version — then hand back the merge/tag/publish sequence | /release | - |
|
|
39
|
-
| skill-creator | Guide for creating effective skills and extending Claude capabilities | /skill-creator <skill-type> <skill-description> |
|
|
38
|
+
| skill-creator | Guide for creating effective skills and extending Claude capabilities | /skill-creator <skill-type> <skill-description> |
|
|
40
39
|
| stash | Save session context for compaction recovery or handoffs | /stash ["optional-name"] | - |
|
|
41
|
-
| debug-method | Four-phase debugging framework - investigate root cause before any fixes | /debug-method <bug-or-error-description> | false |
|
|
42
|
-
| tdd-flow | Write test first, watch it fail, write minimal code to pass | /tdd-flow <feature-or-behavior-to-test> | true |
|
|
43
40
|
| test-generate | Generate tests, run them, verify each one actually exercises the code | /test-generate <file> | - |
|
|
44
|
-
| test-traps | Prevents testing mock behavior and production pollution with test-only methods | /test-traps <testing-scenario> | true |
|
|
45
|
-
| verify-done | Requires running verification commands before making any success claims | /verify-done <work-to-verify> | true |
|
|
46
41
|
|
|
47
42
|
All resources are auto-discovered from frontmatter in their respective directories:
|
|
48
43
|
- **Agents**: `./agent/*.md`
|
|
@@ -41,29 +41,26 @@ digraph CodeDeveloper {
|
|
|
41
41
|
work_type [label="Work type?", shape=diamond];
|
|
42
42
|
|
|
43
43
|
// Context discovery (conditional)
|
|
44
|
-
needs_context [label="Debug
|
|
44
|
+
needs_context [label="Debug or\nrefactor?", shape=diamond];
|
|
45
45
|
context_discovery [label="Context Discovery\n(search related code,\ndeps, usages)", fillcolor=lightyellow];
|
|
46
46
|
|
|
47
47
|
// Debug path
|
|
48
|
-
use_debug [label="Use /
|
|
48
|
+
use_debug [label="Use /root-cause"];
|
|
49
49
|
|
|
50
50
|
// Refactor path
|
|
51
51
|
use_refactor [label="Use /refactor"];
|
|
52
52
|
|
|
53
|
-
// Optimize path
|
|
54
|
-
use_optimize [label="Use /optimize"];
|
|
55
|
-
|
|
56
53
|
// Implement path
|
|
57
54
|
implement [label="Implement changes"];
|
|
58
55
|
|
|
59
56
|
// Conditional testing
|
|
60
57
|
tdd_needed [label="TDD specified\nor tests needed?", shape=diamond];
|
|
61
|
-
use_tdd [label="Use /
|
|
58
|
+
use_tdd [label="Use /test-generate"];
|
|
62
59
|
|
|
63
60
|
// Validation
|
|
64
61
|
run_validations [label="Run validations\n(lint, build, tests)"];
|
|
65
62
|
validations_pass [label="Pass?", shape=diamond];
|
|
66
|
-
fix_issues [label="Fix issues\n(use /
|
|
63
|
+
fix_issues [label="Fix issues\n(use /root-cause if needed)"];
|
|
67
64
|
failure_count [label="3+ failures?", shape=diamond];
|
|
68
65
|
|
|
69
66
|
// Security check
|
|
@@ -80,7 +77,7 @@ digraph CodeDeveloper {
|
|
|
80
77
|
|
|
81
78
|
// Review and complete
|
|
82
79
|
code_review [label="Run /branch-review"];
|
|
83
|
-
verification [label="Run
|
|
80
|
+
verification [label="Run the proof", fillcolor=orange];
|
|
84
81
|
|
|
85
82
|
// Story-specific
|
|
86
83
|
update_story [label="Update story\n(checkbox, changelog)"];
|
|
@@ -104,12 +101,10 @@ digraph CodeDeveloper {
|
|
|
104
101
|
|
|
105
102
|
work_type -> use_debug [label="debug"];
|
|
106
103
|
work_type -> use_refactor [label="refactor"];
|
|
107
|
-
work_type -> use_optimize [label="optimize"];
|
|
108
104
|
work_type -> implement [label="implement"];
|
|
109
105
|
|
|
110
106
|
use_debug -> implement;
|
|
111
107
|
use_refactor -> implement;
|
|
112
|
-
use_optimize -> implement;
|
|
113
108
|
|
|
114
109
|
implement -> tdd_needed;
|
|
115
110
|
tdd_needed -> use_tdd [label="YES"];
|
|
@@ -188,14 +183,13 @@ All require `*` prefix. Invocation commands in table above. Additional:
|
|
|
188
183
|
|
|
189
184
|
| Situation | Delegate To |
|
|
190
185
|
|-----------|-------------|
|
|
191
|
-
| Bug encountered | `/
|
|
192
|
-
| Error deep in stack | `/
|
|
193
|
-
| Refactoring code | `/refactor` |
|
|
194
|
-
| Need tests (when required) | `/test-generate`
|
|
195
|
-
| Writing any test |
|
|
196
|
-
| Before completion |
|
|
186
|
+
| Bug encountered | `/root-cause` |
|
|
187
|
+
| Error deep in stack | `/root-cause` (Phase 1, step 5) |
|
|
188
|
+
| Refactoring code, or a perf problem | `/refactor` (its perf pass is on by default) |
|
|
189
|
+
| Need tests (when required) | `/test-generate` |
|
|
190
|
+
| Writing any test | AGENT_RULES.md → Testing Standards |
|
|
191
|
+
| Before completion | Run the proof and read its output |
|
|
197
192
|
| After code changes | `/security` |
|
|
198
193
|
| Task complete / general review | `/branch-review` (reviews the branch + full security audit, verifies claims, reports findings — never fixes) |
|
|
199
|
-
| Performance issues | `/optimize` |
|
|
200
194
|
|
|
201
195
|
You are an autonomous implementation specialist. Execute with precision, delegate appropriately, and communicate clearly when you need guidance or encounter blockers.
|
|
@@ -63,13 +63,15 @@ digraph QualityAssurance {
|
|
|
63
63
|
|
|
64
64
|
Before any analysis, read (if exists):
|
|
65
65
|
- `AGENTS.md` - Project instructions, patterns, conventions
|
|
66
|
+
<!-- mirror:literal:start — names every tool's config file on purpose -->
|
|
66
67
|
- `AGENT.md` / `AGENTS.md` - Agent configurations
|
|
68
|
+
<!-- mirror:literal:end -->
|
|
67
69
|
- `README.md` - Project overview
|
|
68
70
|
- Test config files (`jest.config`, `pytest.ini`, etc.)
|
|
69
71
|
|
|
70
72
|
## Slash Commands Available
|
|
71
73
|
|
|
72
|
-
Use these during analysis: `/branch-review`, `/security
|
|
74
|
+
Use these during analysis: `/branch-review`, `/security`
|
|
73
75
|
|
|
74
76
|
## Analysis Areas
|
|
75
77
|
|
|
@@ -1,8 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: brainstorming
|
|
3
2
|
description: Use when creating or developing, before writing code or implementation plans - refines rough ideas into fully-formed designs through collaborative questioning, alternative exploration, and incremental validation. Don't use during clear 'mechanical' processes
|
|
4
|
-
usage: /brainstorming <session-type> <topic>
|
|
5
|
-
auto_trigger: false
|
|
6
3
|
---
|
|
7
4
|
|
|
8
5
|
# Brainstorming Ideas Into Designs
|
|
@@ -43,7 +40,7 @@ Start by understanding the current project context, then ask questions one at a
|
|
|
43
40
|
|
|
44
41
|
**Implementation (if continuing):**
|
|
45
42
|
- Ask: "Ready to set up for implementation?"
|
|
46
|
-
- Create isolated workspace
|
|
43
|
+
- Create isolated workspace for implementation
|
|
47
44
|
- Create detailed implementation plan
|
|
48
45
|
|
|
49
46
|
## Key Principles
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: branch-review
|
|
3
2
|
description: Review a branch before merge [target] [level]
|
|
4
|
-
usage: /branch-review [target] [low|medium|high|max]
|
|
5
|
-
argument-hint: [file, branch (e.g. main), range (main..HEAD), or empty] [effort level]
|
|
6
|
-
allowed-tools: Read, Grep, Glob, Agent, Bash(git diff *), Bash(git log *), Bash(git show *), Bash(git status *), Bash(git grep *), Bash(git rev-parse *), Bash(git merge-base *), Bash(rg *)
|
|
7
3
|
---
|
|
8
4
|
Pre-merge review gate. Two stages — **general review** then a **full security
|
|
9
5
|
audit** — followed by an adversarial verify pass. It **never edits code**: it
|
|
@@ -11,7 +7,7 @@ reports findings and hands them back. Fixing is a separate, separately
|
|
|
11
7
|
authorized action.
|
|
12
8
|
|
|
13
9
|
Only **Critical** and **High** findings block the merge. Everything else is
|
|
14
|
-
appended to the **fix ledger** (`.
|
|
10
|
+
appended to the **fix ledger** (`.opencode/remember/fix-ledger.md`) — a local,
|
|
15
11
|
cumulative list, living beside `MEMORY.md`, that `/refactor` (no arguments)
|
|
16
12
|
works through between features. Like its neighbours it is a private working
|
|
17
13
|
artifact, usually gitignored; it persists across reviews, it is not a
|
|
@@ -44,17 +40,17 @@ at the current HEAD SHA.
|
|
|
44
40
|
review of a report. (Same rule `/security` carries inside stage 2.)
|
|
45
41
|
- **No edits — two exceptions.** You have no authorization to change code,
|
|
46
42
|
even for a finding you are certain about. Report it. The only files you may
|
|
47
|
-
write are `.
|
|
48
|
-
delete) and `.
|
|
43
|
+
write are `.opencode/remember/fix-ledger.md` (append bullets; never rewrite or
|
|
44
|
+
delete) and `.opencode/remember/last-review.md` (overwrite; the review record
|
|
49
45
|
described at the end of this file).
|
|
50
46
|
- **Prove it with two checks, because neither sees what the other does.**
|
|
51
47
|
`git status --porcelain`, at start and again before you report, proves no
|
|
52
48
|
**tracked** file changed — that is the "never edits code" guarantee, and it
|
|
53
|
-
is the one that matters. It cannot police your own two writes: `.
|
|
49
|
+
is the one that matters. It cannot police your own two writes: `.opencode/`
|
|
54
50
|
is normally gitignored, so porcelain stays empty whether you wrote the
|
|
55
51
|
allowed files, wrote nothing, or overwrote `MEMORY.md`. `git status
|
|
56
|
-
--ignored` does not close it either — it collapses to `!! .
|
|
57
|
-
directory, not the files. So also take `md5sum .
|
|
52
|
+
--ignored` does not close it either — it collapses to `!! .opencode/`, the
|
|
53
|
+
directory, not the files. So also take `md5sum .opencode/remember/*` before
|
|
58
54
|
you start and again before you report, and show the comparison: only
|
|
59
55
|
`fix-ledger.md` and `last-review.md` may differ.
|
|
60
56
|
|
|
@@ -95,11 +91,25 @@ Record the **HEAD SHA** you reviewed, and **report the target you resolved**
|
|
|
95
91
|
(the literal range or path) in your output, so the orchestrator can see what
|
|
96
92
|
was actually read rather than assuming.
|
|
97
93
|
|
|
98
|
-
**Re-review after fixes: read `.
|
|
94
|
+
**Re-review after fixes: read `.opencode/remember/last-review.md` first.** Its
|
|
99
95
|
`sha:` line is the previously-reviewed commit and its `blockers:` list is what
|
|
100
96
|
you owe an answer on — take both from the file, never from the orchestrator's
|
|
101
97
|
recollection, for the same reason `/release` does. Then:
|
|
102
98
|
|
|
99
|
+
- **First, check the record belongs to this branch.** There is one record file
|
|
100
|
+
per repo, not one per branch. Validate `<that sha>` first with
|
|
101
|
+
`git rev-parse --verify <that sha>` — a value that fails this (e.g. a
|
|
102
|
+
corrupted or hand-edited record, or one starting with `-`, which git would
|
|
103
|
+
otherwise parse as an option) is a malformed record; treat it exactly as
|
|
104
|
+
**No file** below. If it validates, and its `branch:` line differs from the
|
|
105
|
+
current branch, or `git merge-base --is-ancestor <that sha> HEAD` exits
|
|
106
|
+
non-zero, the record describes a different or rewritten history — treat it
|
|
107
|
+
exactly as **No file** below and review the whole branch. Skipping this
|
|
108
|
+
resolves `<that sha>..HEAD` against a merged, renamed, or rebased sha, which
|
|
109
|
+
is not a subset of this branch but a range that never existed. Check both:
|
|
110
|
+
the branch name catches a switch, the ancestry check catches a rebase or
|
|
111
|
+
squash under the same name. Otherwise:
|
|
112
|
+
|
|
103
113
|
- **`sha:` ≠ HEAD** → this is a re-review. Target the range
|
|
104
114
|
`<that sha>..HEAD`. Stage 1 reads only the commits since, and stage 3
|
|
105
115
|
re-verifies each recorded blocker as fixed, unfixed, or dismissed with a
|
|
@@ -231,7 +241,7 @@ check before escalating.
|
|
|
231
241
|
|
|
232
242
|
### Ledger (non-blocking — medium / low)
|
|
233
243
|
Not in the report. **Append** each one as a single bullet to
|
|
234
|
-
`.
|
|
244
|
+
`.opencode/remember/fix-ledger.md` (create the file with the header below if
|
|
235
245
|
missing):
|
|
236
246
|
|
|
237
247
|
```
|
|
@@ -256,7 +266,7 @@ with `UNVERIFIED:` so `/refactor` retests before acting.
|
|
|
256
266
|
The **snippet is the anchor**: 20–60 verbatim characters from the line,
|
|
257
267
|
unique enough for `git grep -F` to find it after lines shift. No line
|
|
258
268
|
numbers, no TODO comments in code — the ledger is the single writer. Before
|
|
259
|
-
appending, dedupe with **plain `grep -F "<snippet>" .
|
|
269
|
+
appending, dedupe with **plain `grep -F "<snippet>" .opencode/remember/fix-ledger.md`**;
|
|
260
270
|
if it is already there, skip it. Do not touch existing bullets.
|
|
261
271
|
|
|
262
272
|
**A bullet you disprove is deleted, not annotated.** If you establish that an
|
|
@@ -280,7 +290,7 @@ Then a coverage line: stage 1 at level `<level>`, stage 2 full, stage 3 —
|
|
|
280
290
|
each `ran ✓/✗` with its evidence. A stage you did not actually run is a **✗**, never an
|
|
281
291
|
assumed pass.
|
|
282
292
|
|
|
283
|
-
**Write the review record** to `.
|
|
293
|
+
**Write the review record** to `.opencode/remember/last-review.md`, overwriting
|
|
284
294
|
it. `/release` reads this file; a SHA that lives only in a chat message is
|
|
285
295
|
gone after a compaction or a handover, and the only remaining source is the
|
|
286
296
|
orchestrator — the one party this command already refuses to take a review's
|
|
@@ -326,7 +336,7 @@ does not move — which means nothing was fixed, which is the correct outcome.
|
|
|
326
336
|
|
|
327
337
|
End with:
|
|
328
338
|
- **Reviewed at HEAD `<sha>` on `<branch>`, target `<resolved range or path>`,
|
|
329
|
-
tree clean at start; at exit clean or the two `.
|
|
339
|
+
tree clean at start; at exit clean or the two `.opencode/remember/` paths
|
|
330
340
|
only.**
|
|
331
341
|
- **Fix ledger: N open, M added this run** (N = bullet count). When N > 0,
|
|
332
342
|
add: "N fixes waiting — run `/refactor` between features." The ledger is a
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: docs-builder
|
|
3
2
|
description: Reorg a docs corpus, split an oversized doc, search it, keep pages current, index them
|
|
4
|
-
usage: /docs-builder [reorg | cleanup <file.md> | search <query words...>]
|
|
5
|
-
argument-hint: [reorg | cleanup <file.md> | search <query words...> — empty asks first run vs. drift]
|
|
6
|
-
allowed-tools: Read, Write, Edit, Grep, Glob, Task, AskUserQuestion, Bash(node:*), Bash(git:*), Bash(rg:*)
|
|
7
3
|
---
|
|
8
4
|
|
|
9
5
|
# docs-builder
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: live-canvas
|
|
3
2
|
description: Conduct design interviews, generate UI variations, and collect live click-to-annotate feedback that streams into the session so edits land without leaving the browser. Use when the user wants rapid iterative UI refinement, not just batched feedback.
|
|
4
3
|
---
|
|
5
4
|
|
|
@@ -26,7 +25,7 @@ Live Canvas supports two feedback transports. **The user picks every time** —
|
|
|
26
25
|
|
|
27
26
|
### Host detection — do this first
|
|
28
27
|
|
|
29
|
-
This SKILL.md is the Claude Code variant of the skill. Same content is mirrored as docs for Droid/Amp/Opencode under `packages/<tool
|
|
28
|
+
This SKILL.md is the Claude Code variant of the skill. Same content is mirrored as docs for Droid/Amp/Opencode under `packages/<tool>/` beside the other capabilities, but those tools don't support the MCP channel.
|
|
30
29
|
|
|
31
30
|
**If running under Droid, Amp, or Opencode (not Claude Code):**
|
|
32
31
|
- Skip the mode question entirely.
|
|
@@ -109,6 +108,8 @@ Or pick JSON now to stay in this session — feedback gets written to a file
|
|
|
109
108
|
you paste back here. No relaunch needed.
|
|
110
109
|
```
|
|
111
110
|
|
|
111
|
+
<!-- mirror:literal:start — Live mode is the Claude Code MCP plugin; these are
|
|
112
|
+
Claude's real paths in every kit, because no other tool can install it -->
|
|
112
113
|
**Case C — first-time setup block:**
|
|
113
114
|
|
|
114
115
|
```
|
|
@@ -125,6 +126,7 @@ Live mode needs a one-time install. Two steps:
|
|
|
125
126
|
That's it — once the plugin is installed, /live-canvas in any session can
|
|
126
127
|
claim the channel. Re-run /live-canvas and pick Live.
|
|
127
128
|
```
|
|
129
|
+
<!-- mirror:literal:end -->
|
|
128
130
|
|
|
129
131
|
Do not try to run any of these commands yourself. Three reasons:
|
|
130
132
|
1. The `/plugin` steps are Claude Code slash commands — not doable from inside a running session.
|
|
@@ -418,7 +420,7 @@ Create all files under `.claude-design/`:
|
|
|
418
420
|
|
|
419
421
|
### The overlay
|
|
420
422
|
|
|
421
|
-
**One template, every framework:** `~/.
|
|
423
|
+
**One template, every framework:** `~/.config/opencode/command/live-canvas/templates/overlay-vanilla.js`. Single file, zero dependencies, plain DOM. Works in vanilla JS, Vue, Svelte, Rails, Django, Phoenix, plain HTML, Next.js, Vite-React, Remix — anywhere a `<script>` tag runs.
|
|
422
424
|
|
|
423
425
|
Copy it into a directory served by the dev server (e.g. `public/overlay-vanilla.js` for Next.js, `static/overlay-vanilla.js` for Vite, the public dir for Rails/Django). Reference it from the lab page.
|
|
424
426
|
|
|
@@ -545,7 +547,7 @@ The Live Canvas page must include:
|
|
|
545
547
|
1. **Header** with:
|
|
546
548
|
- Design Brief summary (target, scope, key requirements)
|
|
547
549
|
- Instructions for reviewing
|
|
548
|
-
- **Lab banner (REQUIRED)** — paste `~/.
|
|
550
|
+
- **Lab banner (REQUIRED)** — paste `~/.config/opencode/command/live-canvas/templates/lab-banner.html` at the top of the lab page. Same text in any mode. For React/TSX labs, translate the inline style to a JS object: camelCase keys, string values. E.g. `style="border-radius:8px; padding:10px 14px; font-size:13px"` → `style={{ borderRadius: '8px', padding: '10px 14px', fontSize: '13px' }}`. Keep the text and `role="note"`.
|
|
549
551
|
|
|
550
552
|
2. **Variant Grid** with:
|
|
551
553
|
- Clear labels (A, B, C, D, E)
|
|
@@ -568,7 +570,7 @@ The Live Canvas page must include:
|
|
|
568
570
|
|
|
569
571
|
The overlay (`overlay-vanilla.js`) enables users to click on elements and leave comments. Without it, the Live Canvas is just a static page with no way to collect structured feedback.
|
|
570
572
|
|
|
571
|
-
- Copy `~/.
|
|
573
|
+
- Copy `~/.config/opencode/command/live-canvas/templates/overlay-vanilla.js` into a directory served by the dev server (e.g. `public/`, `static/`, or wherever the framework serves static assets).
|
|
572
574
|
- Reference it from the lab page via `<script>` tag and call `LiveCanvas.init({...})` once with `target`, `channelUrl` (Live mode), and optional `batchEndpoint`. See "Wiring the overlay" above for the exact snippets per framework.
|
|
573
575
|
- Every variant container in the lab page MUST have a `data-variant="X"` attribute (A, B, C, D, E, or F). The overlay uses this to route comments to the right variant file.
|
|
574
576
|
|
|
@@ -1,11 +1,8 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
description: Refactor [code]
|
|
4
|
-
usage: /refactor <code-section> | /refactor (no args = fix-ledger mode)
|
|
5
|
-
argument-hint: [file-or-function, or empty for the fix ledger]
|
|
6
|
-
allowed-tools: Read, Edit, Grep, Glob, Bash(npm test *), Bash(npx jest *), Bash(npx vitest *), Bash(pnpm test *), Bash(yarn test *), Bash(pytest *), Bash(python *), Bash(go test *), Bash(cargo test *), Bash(make test *), Bash(git diff *), Bash(git grep *), Bash(git status *), Bash(git rev-parse *), Bash(git switch *)
|
|
2
|
+
description: Refactor and optimize [code]
|
|
7
3
|
---
|
|
8
|
-
Refactor $ARGUMENTS.
|
|
4
|
+
Refactor $ARGUMENTS. A targeted refactor includes the performance pass
|
|
5
|
+
below — it is on by default, not a separate command.
|
|
9
6
|
|
|
10
7
|
## Guardrails
|
|
11
8
|
- **Spawn a worker and explicitly select your tool's mid tier.** State the
|
|
@@ -44,15 +41,15 @@ Refactor $ARGUMENTS.
|
|
|
44
41
|
other does.** `git status --porcelain` at exit must list only files a
|
|
45
42
|
surviving bullet named — that is this command's scope guarantee, and unlike
|
|
46
43
|
`/branch-review` it is not expected to be empty. It cannot police the
|
|
47
|
-
memory directory: `.
|
|
44
|
+
memory directory: `.opencode/` is normally gitignored, so porcelain stays
|
|
48
45
|
empty whether you deleted a fixed bullet, wrote nothing, or overwrote
|
|
49
|
-
`MEMORY.md`. So also take `md5sum .
|
|
46
|
+
`MEMORY.md`. So also take `md5sum .opencode/remember/*` before you start and
|
|
50
47
|
again before you report, and show the comparison: only `fix-ledger.md` may
|
|
51
48
|
differ. `last-review.md` in particular is `/branch-review`'s to write —
|
|
52
49
|
a fixer that touches it forges the gate that judges its own work.
|
|
53
50
|
|
|
54
51
|
## Ledger mode — `$ARGUMENTS` empty
|
|
55
|
-
Work through `.
|
|
52
|
+
Work through `.opencode/remember/fix-ledger.md`, the non-blocking findings
|
|
56
53
|
`/branch-review` has accumulated. Everything below (goals, constraints,
|
|
57
54
|
verification, HITL gates) still applies; this section only says what to
|
|
58
55
|
refactor and how to close each item.
|
|
@@ -87,6 +84,35 @@ refactor and how to close each item.
|
|
|
87
84
|
- Apply DRY
|
|
88
85
|
- Better naming
|
|
89
86
|
- Smaller functions (single responsibility)
|
|
87
|
+
- Remove needless work — the performance pass below
|
|
88
|
+
|
|
89
|
+
## Performance — part of every targeted refactor
|
|
90
|
+
When `$ARGUMENTS` names a target, look for wasted work as well as messy
|
|
91
|
+
work: time and space complexity, N+1 queries, I/O inside a loop, needless
|
|
92
|
+
allocations, the same value recomputed repeatedly.
|
|
93
|
+
|
|
94
|
+
**Ground every finding before you touch it.** Performance claims are easy
|
|
95
|
+
to invent. A finding counts as **confirmed** only with at least one of:
|
|
96
|
+
- a profile, benchmark or log line showing call frequency or duration,
|
|
97
|
+
- the path sits on an obvious hot loop or per-request handler with real
|
|
98
|
+
volume,
|
|
99
|
+
- the user supplied evidence in the request.
|
|
100
|
+
|
|
101
|
+
Without one of those it is **uncertain — report it, do not optimise it.**
|
|
102
|
+
Speculative optimisation is scope creep with a stopwatch.
|
|
103
|
+
|
|
104
|
+
Fix confirmed findings under the same constraints as any other refactor:
|
|
105
|
+
minimal change, one obvious shape, no behaviour change, no API change.
|
|
106
|
+
After each such edit, re-read the changed region and confirm it still
|
|
107
|
+
computes the same answer — a perf change that quietly alters semantics is
|
|
108
|
+
the worst kind. Report per finding: **location** (`file:line`), **cost**
|
|
109
|
+
(concrete — "N+1 over ~1k rows on every page load", not "could be
|
|
110
|
+
faster"), **change**, **expected improvement**, **trade-off**
|
|
111
|
+
(readability / memory / consistency).
|
|
112
|
+
|
|
113
|
+
In ledger mode the surviving bullets are the whole scope — do not add
|
|
114
|
+
perf findings of your own. One you notice goes back to the orchestrator
|
|
115
|
+
as a new bullet, like any other side finding.
|
|
90
116
|
|
|
91
117
|
## Constraints
|
|
92
118
|
- **NO behavior changes**
|
|
@@ -120,8 +146,20 @@ honest way to know is to run them.
|
|
|
120
146
|
- the change is **bigger than the user asked for** (scope creep —
|
|
121
147
|
unrelated cleanups, formatting, comment edits). Confirm before
|
|
122
148
|
applying.
|
|
149
|
+
- a perf fix has **multiple reasonable shapes** (cache vs precompute vs
|
|
150
|
+
batch vs paginate vs index) — present the options with trade-offs, not
|
|
151
|
+
a chosen path.
|
|
152
|
+
- a perf fix trades **correctness for speed** (lossy approximation,
|
|
153
|
+
weaker or eventual consistency) — even when it is "obviously" faster.
|
|
154
|
+
- a perf fix touches **concurrency primitives** (locks, atomics,
|
|
155
|
+
ordering) — easy to introduce a race.
|
|
156
|
+
- a perf fix changes a **DB schema, response shape or caller contract**.
|
|
123
157
|
|
|
124
158
|
Final report:
|
|
125
159
|
- **refactor done, tests N pass / 0 fail** — ready, OR
|
|
126
160
|
- **refactor done, but K tests fail** — awaiting direction (revert /
|
|
127
161
|
patch / update test).
|
|
162
|
+
|
|
163
|
+
Plus the performance pass: **confirmed-and-fixed** · **confirmed-but-asking**
|
|
164
|
+
(why + options) · **uncertain** (what profiling or data would settle it) ·
|
|
165
|
+
**none found**.
|
|
@@ -1,8 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
name: release
|
|
3
2
|
description: Verify, sweep docs, cut a version — then hand the release sequence back
|
|
4
|
-
usage: /release
|
|
5
|
-
allowed-tools: Read, Grep, Glob, Edit, Write, Agent, Bash(git status *), Bash(git diff *), Bash(git log *), Bash(git show *), Bash(git fetch *), Bash(git add *), Bash(git commit *), Bash(git rev-parse *), Bash(git merge-base *), Bash(npm *), Bash(pnpm *), Bash(yarn *), Bash(pytest *), Bash(python *), Bash(go *), Bash(cargo *), Bash(make *)
|
|
6
3
|
---
|
|
7
4
|
Release **preparation** orchestrator for the **current branch**. It runs your
|
|
8
5
|
existing pre-deploy gate, sweeps the docs, bumps the version and commits —
|
|
@@ -57,7 +54,7 @@ A review must have run on this branch **at the current HEAD SHA**.
|
|
|
57
54
|
|
|
58
55
|
**Compare the SHAs yourself; do not settle for an answer.** Run `git rev-parse
|
|
59
56
|
HEAD` and compare it against the `sha:` line in
|
|
60
|
-
`.
|
|
57
|
+
`.opencode/remember/last-review.md`, which `/branch-review` writes. Asking the
|
|
61
58
|
orchestrator "did a review run?" puts the question to the one party with an
|
|
62
59
|
incentive to say yes, so its word is not evidence — and neither is a SHA
|
|
63
60
|
quoted from a chat message, which is the same claim in another costume and is
|
|
@@ -72,7 +69,7 @@ that predates this file's introduction has no record, so it does not count.
|
|
|
72
69
|
is what makes "all findings fixed" checkable instead of promised.
|
|
73
70
|
**No exceptions — including the fix ledger.** It is normally gitignored, so
|
|
74
71
|
appending to it moves nothing and this never comes up. A repo that tracks
|
|
75
|
-
`.
|
|
72
|
+
`.opencode/` instead will see a ledger commit land after the review and make
|
|
76
73
|
it stale. That is the rule working, not a case to carve out: re-review, or
|
|
77
74
|
leave the ledger uncommitted until after the release.
|
|
78
75
|
- **`coverage:` naming any stage `NOT RUN`** → **stop**. A `ready` from a run
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
6. [Environment](#environment)
|
|
10
10
|
7. [Development Workflow](#development-workflow)
|
|
11
11
|
8. [Twelve-Factor Checklist](#twelve-factor-checklist)
|
|
12
|
-
9. [
|
|
12
|
+
9. [CLAUDE.md Stub](#claudemd-stub)
|
|
13
13
|
|
|
14
14
|
---
|
|
15
15
|
|
|
@@ -59,7 +59,7 @@ Every task runs through three layers. Do not skip ahead to code.
|
|
|
59
59
|
Not courtesies. These bind you as written, whether or not your tool enforces them.
|
|
60
60
|
|
|
61
61
|
- **Always** identify affected files before making changes, and explain what will change and why
|
|
62
|
-
- **Ask first** — stop and get explicit sign-off — before modifying authentication systems, database schema or migrations, CI workflows, or `.
|
|
62
|
+
- **Ask first** — stop and get explicit sign-off — before modifying authentication systems, database schema or migrations, CI workflows, or `.claude/settings.json`
|
|
63
63
|
- **Never** write secrets into the tree (`.env`/`*.env`, keys, credentials). They load from the environment at runtime; only a value-less `.env.example` is committed
|
|
64
64
|
- **Never** commit to `main`. Commit to a new branch (name doesn't matter), then propose `/branch-review` followed by `/release`; merging and releasing are my call, made by name — "approve", "good", or "go" on a draft is not that call
|
|
65
65
|
|
|
@@ -130,90 +130,50 @@ A problem you see and don't fix goes in the report, never in a comment. Comments
|
|
|
130
130
|
|
|
131
131
|
## Testing Standards
|
|
132
132
|
|
|
133
|
-
|
|
133
|
+
Principles, not a framework. Whatever the language, follow its ecosystem's conventions for
|
|
134
|
+
runner, layout and fixtures — these rules govern what a test must *do*, never how a
|
|
135
|
+
particular toolchain spells it.
|
|
134
136
|
|
|
135
|
-
|
|
137
|
+
### What a test is for
|
|
136
138
|
|
|
137
|
-
**
|
|
138
|
-
- Few unit tests — only for pure logic, algorithms, and complex calculations
|
|
139
|
-
- Many integration tests — the sweet spot; test real components working together
|
|
140
|
-
- Some E2E tests — cover critical user journeys end-to-end
|
|
141
|
-
- Static analysis — types and linters catch bugs cheaper than tests
|
|
139
|
+
**Test behavior, not implementation.** A suite must give you confidence to refactor freely. If changing internal code without changing behavior breaks tests, those tests are liabilities, not assets.
|
|
142
140
|
|
|
143
|
-
|
|
141
|
+
**Shape — the Testing Trophy, not the Pyramid:** static analysis catches the cheapest bugs; few unit tests, for pure logic and algorithms; many integration tests, the sweet spot, real components working together; some end-to-end tests over the critical journeys. Target roughly 20% unit, 60% integration, 15% E2E, 5% manual.
|
|
144
142
|
|
|
145
|
-
|
|
146
|
-
- **Write tests when the code has users.** If a function is called by other modules or exposed to users, it needs tests. Internal helpers that only serve one caller don't need their own test file
|
|
147
|
-
- **Write tests for bugs.** Every bug fix must include a regression test that fails before the fix and passes after. This is the highest-value test you can write
|
|
148
|
-
- **Write tests before refactoring.** Before changing working code, write characterization tests first to lock in current behavior, then refactor with confidence
|
|
149
|
-
- **Do not write tests for glue code.** Code that just wires components together (calls A then B then C) is tested at the integration level, not unit level
|
|
143
|
+
### When to write them
|
|
150
144
|
|
|
151
|
-
|
|
145
|
+
- **After the design stabilizes, not during exploration.** Do not test a prototype — you will write tests for code you delete tomorrow. First make it work (POC), then make it right (tests), then make it fast
|
|
146
|
+
- **Tests first when you already know the contract.** Pure functions, algorithms, parsers, validators, data transformations — write the test, watch it fail, then implement. When you are still discovering the interface, that same discipline produces churn and false confidence
|
|
147
|
+
- **Write tests for bugs.** Every fix ships a regression test that fails before the fix and passes after — the highest-value test there is
|
|
148
|
+
- **Write tests before refactoring.** Characterization tests lock in current behavior first, then change the code
|
|
149
|
+
- **Write tests when the code has users.** Called by other modules or exposed externally means it needs tests; a helper serving one caller does not need its own file
|
|
150
|
+
- **Do not test glue code.** Something that only wires A to B to C is covered at the integration level
|
|
152
151
|
|
|
153
|
-
|
|
154
|
-
- **TDD does not work for:** Exploring a design, building a POC, or unstable interfaces. Writing tests for unstable APIs creates churn and false confidence
|
|
155
|
-
- **The rule:** You must understand what you're building before you TDD it. TDD is a design tool for known problems, not a discovery tool for unknown ones
|
|
156
|
-
- **Red-green-refactor discipline:** If you do TDD, follow the cycle strictly. Write a failing test, write minimal code to pass, refactor. Do not write 20 tests then implement — that's front-loading waste
|
|
152
|
+
### What makes a good test
|
|
157
153
|
|
|
158
|
-
|
|
154
|
+
- **Tests real behavior.** Call the public interface, assert on observable output. Never reach into internals
|
|
155
|
+
- **Fails for the right reason.** It breaks when the feature breaks, not when the implementation moves
|
|
156
|
+
- **Reads like a spec.** Someone new to the code should learn what the feature does by reading it
|
|
157
|
+
- **Self-contained.** Sets up its own state, runs, cleans up. No ordering dependencies, and no reliance on project directories, user config, or ambient environment
|
|
158
|
+
- **Deterministic.** Flaky tests erode trust. A dependency on timing, network, or global state is a defect in the test
|
|
159
|
+
- **Never sleep for a condition — poll for it.** Sleeping then asserting is wrong at every value: too short and it flakes under load, too long and the suite drags, and a real async bug looks identical to a guess that was too short. Wait on the condition itself, re-reading the state *inside* the loop, with a timeout that names what it was waiting for. A fixed delay is only correct once you have waited for the triggering condition, the delay comes from a documented interval rather than a guess, and a comment says why
|
|
159
160
|
|
|
160
|
-
-
|
|
161
|
-
- **Fails for the right reason.** A good test fails when the feature is broken, not when the implementation changes
|
|
162
|
-
- **Reads like a spec.** Someone unfamiliar with the code must understand what the feature does by reading the test
|
|
163
|
-
- **Self-contained.** Each test sets up its own state, runs, and cleans up. No ordering dependencies between tests
|
|
164
|
-
- **Fast and deterministic.** Flaky tests erode trust. If a test depends on timing, network, or global state, fix that dependency
|
|
161
|
+
### Anti-patterns
|
|
165
162
|
|
|
166
|
-
|
|
163
|
+
- **Mocking most of the test.** If mock setup outweighs the logic, you are testing mocks. Prefer the real thing against a temporary directory, an in-memory store, or a disposable container
|
|
164
|
+
- **Partial mocks.** Mirror the complete structure the real thing returns, not only the fields this test reads. A mock missing a field downstream code consumes passes here and fails in production
|
|
165
|
+
- **Smoke tests.** Asserting a result merely exists proves nothing. Assert on specific values, structure, or side effects
|
|
166
|
+
- **Testing private internals.** If it needs its own test, it should be part of the public interface; otherwise the public tests should reach it
|
|
167
|
+
- **Mirroring implementation.** A test that restates the source line by line breaks on every refactor and catches nothing
|
|
168
|
+
- **Test-only production code.** Never add a method, flag, or branch to production solely for tests. Inject the dependency instead
|
|
169
|
+
- **Chasing a coverage number.** 80% of meaningless tests is worse than 40% of behavioural ones. Coverage tells you what is *not* tested, never that what is covered is correct. Cover the critical path first — data, auth, money, core logic — before helpers
|
|
167
170
|
|
|
168
|
-
|
|
169
|
-
- **Smoke tests.** `assert result is not None` proves nothing. Assert on specific values, structure, or side effects
|
|
170
|
-
- **Testing private methods.** If you need to test a private method, either it should be public or the public method's tests should cover it
|
|
171
|
-
- **Mirroring implementation.** Tests that replicate the source code line-by-line break on every refactor and catch zero bugs
|
|
172
|
-
- **Test-only production code.** Never add methods, flags, or branches to production code solely for testing. Use dependency injection instead
|
|
171
|
+
### Organization
|
|
173
172
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
- **
|
|
177
|
-
- **
|
|
178
|
-
```
|
|
179
|
-
packages/<pkg>/tests/
|
|
180
|
-
unit/ # Fast, isolated, mocked deps, <1s each
|
|
181
|
-
integration/ # Real DB, filesystem, multi-component, <10s each
|
|
182
|
-
e2e/ # Full workflows, subprocess calls, <60s each
|
|
183
|
-
conftest.py # Shared fixtures for this package
|
|
184
|
-
```
|
|
185
|
-
- **One test file per module** (not per function). `test_auth.py` tests the auth module, not `test_login.py` + `test_logout.py` + `test_session.py`
|
|
186
|
-
- **No duplicate test files.** Before creating a new test file, check if one already exists for that module
|
|
187
|
-
|
|
188
|
-
### Markers and Signals
|
|
189
|
-
|
|
190
|
-
| Marker | Purpose | CI Behavior |
|
|
191
|
-
|--------|---------|-------------|
|
|
192
|
-
| `@pytest.mark.slow` | Runtime > 5s | Run in full suite, skip in quick checks |
|
|
193
|
-
| `@pytest.mark.ml` | Requires ML deps (torch, etc.) | Skip if deps not installed |
|
|
194
|
-
| `@pytest.mark.real_api` | Calls external APIs | Skip in CI — run manually before release |
|
|
195
|
-
|
|
196
|
-
**CI runs for fast signals:**
|
|
197
|
-
- `pytest -m "not slow and not ml and not real_api"` — fast gate on every push (~30s)
|
|
198
|
-
- `pytest` — full suite on PR merge or nightly
|
|
199
|
-
- Package-level runs for targeted debugging: `pytest packages/core/tests/`
|
|
200
|
-
|
|
201
|
-
### Coverage and Ratios
|
|
202
|
-
|
|
203
|
-
- **Do not chase a coverage number.** 80% coverage with meaningless tests is worse than 40% with behavior-testing integration tests
|
|
204
|
-
- **Cover the critical path first.** Data layer, auth, payment, core business logic — before helper utilities
|
|
205
|
-
- **Coverage tells you what's NOT tested, not what IS tested.** High coverage with bad assertions is false confidence
|
|
206
|
-
- **Delete tests that don't catch bugs.** If a test has never failed (or only fails on refactors), it's not providing value
|
|
207
|
-
|
|
208
|
-
**Target ratio:** ~20% unit, ~60% integration, ~15% E2E, ~5% manual/exploratory
|
|
209
|
-
|
|
210
|
-
### Test Tooling Standards
|
|
211
|
-
|
|
212
|
-
- Use `tmp_path` for filesystem tests, `:memory:` or `tmp_path` SQLite for DB tests
|
|
213
|
-
- Use dependency injection over `@patch` — it's more readable and survives refactors
|
|
214
|
-
- Tests must be self-sufficient — no dependency on project directories, user config, or environment state
|
|
215
|
-
- Use factories or builders for test data, not raw constructors with 15 arguments
|
|
216
|
-
- Keep test fixtures close to where they're used. Shared fixtures in `conftest.py`, not a global test utilities package
|
|
173
|
+
- **Mirror the source structure**, at whatever level the ecosystem puts tests. One test file per module, not per function, and never a second file covering a module that already has one
|
|
174
|
+
- **Separate by cost so CI gets a fast signal.** Keep quick isolated tests apart from ones needing real IO or a full workflow, and let the slow ones — long runtimes, heavy optional dependencies, live external APIs — be excluded from the gate that runs on every push and included in the full run
|
|
175
|
+
- **Fixtures live near what uses them**, shared upward only when genuinely shared. Build test data with factories or builders, never a constructor taking fifteen positional arguments
|
|
176
|
+
- **Delete tests that never catch anything.** A test that has only ever failed during refactors is a maintenance cost, not a safety net
|
|
217
177
|
|
|
218
178
|
---
|
|
219
179
|
|
|
@@ -281,9 +241,9 @@ The [Twelve-Factor App](https://12factor.net) methodology for modern, scalable a
|
|
|
281
241
|
|
|
282
242
|
---
|
|
283
243
|
|
|
284
|
-
##
|
|
244
|
+
## CLAUDE.md Stub
|
|
285
245
|
|
|
286
|
-
Copy this to any project's
|
|
246
|
+
Copy this to any project's CLAUDE.md. These are mandatory rules, not suggestions.
|
|
287
247
|
|
|
288
248
|
```markdown
|
|
289
249
|
## Dev Rules
|
|
@@ -304,5 +264,5 @@ Copy this to any project's AGENTS.md. These are mandatory rules, not suggestions
|
|
|
304
264
|
|
|
305
265
|
**Responsive web UI is mandatory.** Any web UI must work on mobile by default — fluid layouts, viewport meta, breakpoints, no horizontal scroll. Verify in DevTools device emulation before claiming a UI task is done. POCs exempt; real projects are not.
|
|
306
266
|
|
|
307
|
-
For full development and testing standards, see `.
|
|
267
|
+
For full development and testing standards, see `.claude/remember/AGENT_RULES.md`.
|
|
308
268
|
```
|