maxsimcli 4.8.0 → 4.10.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/README.md +180 -202
- package/dist/assets/CHANGELOG.md +61 -0
- package/dist/assets/hooks/maxsim-check-update.cjs +38 -0
- package/dist/assets/hooks/maxsim-check-update.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-statusline.cjs +116 -48
- package/dist/assets/hooks/maxsim-statusline.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-sync-reminder.cjs +117 -0
- package/dist/assets/hooks/maxsim-sync-reminder.cjs.map +1 -0
- package/dist/assets/templates/agents/AGENTS.md +78 -106
- package/dist/assets/templates/agents/executor.md +101 -0
- package/dist/assets/templates/agents/planner.md +86 -0
- package/dist/assets/templates/agents/researcher.md +71 -0
- package/dist/assets/templates/agents/verifier.md +88 -0
- package/dist/assets/templates/commands/maxsim/debug.md +7 -7
- package/dist/assets/templates/commands/maxsim/execute.md +45 -0
- package/dist/assets/templates/commands/maxsim/go.md +29 -0
- package/dist/assets/templates/commands/maxsim/help.md +2 -2
- package/dist/assets/templates/commands/maxsim/init.md +52 -0
- package/dist/assets/templates/commands/maxsim/plan.md +50 -0
- package/dist/assets/templates/commands/maxsim/progress.md +4 -3
- package/dist/assets/templates/commands/maxsim/quick.md +6 -4
- package/dist/assets/templates/commands/maxsim/settings.md +4 -3
- package/dist/assets/templates/references/continuation-format.md +16 -16
- package/dist/assets/templates/references/model-profile-resolution.md +1 -1
- package/dist/assets/templates/references/model-profiles.md +12 -19
- package/dist/assets/templates/rules/conventions.md +51 -0
- package/dist/assets/templates/rules/verification-protocol.md +57 -0
- package/dist/assets/templates/skills/agent-system-map/SKILL.md +92 -0
- package/dist/assets/templates/skills/brainstorming/SKILL.md +48 -36
- package/dist/assets/templates/skills/code-review/SKILL.md +40 -61
- package/dist/assets/templates/skills/commit-conventions/SKILL.md +75 -0
- package/dist/assets/templates/skills/evidence-collection/SKILL.md +87 -0
- package/dist/assets/templates/skills/handoff-contract/SKILL.md +70 -0
- package/dist/assets/templates/skills/input-validation/SKILL.md +51 -0
- package/dist/assets/templates/skills/maxsim-batch/SKILL.md +41 -45
- package/dist/assets/templates/skills/maxsim-simplify/SKILL.md +37 -90
- package/dist/assets/templates/skills/memory-management/SKILL.md +32 -67
- package/dist/assets/templates/skills/research-methodology/SKILL.md +137 -0
- package/dist/assets/templates/skills/roadmap-writing/SKILL.md +40 -58
- package/dist/assets/templates/skills/sdd/SKILL.md +34 -69
- package/dist/assets/templates/skills/systematic-debugging/SKILL.md +20 -26
- package/dist/assets/templates/skills/tdd/SKILL.md +25 -33
- package/dist/assets/templates/skills/tool-priority-guide/SKILL.md +80 -0
- package/dist/assets/templates/skills/using-maxsim/SKILL.md +42 -73
- package/dist/assets/templates/skills/verification-before-completion/SKILL.md +12 -24
- package/dist/assets/templates/skills/verification-gates/SKILL.md +169 -0
- package/dist/assets/templates/templates/UAT.md +3 -3
- package/dist/assets/templates/templates/VALIDATION.md +1 -1
- package/dist/assets/templates/templates/context.md +4 -4
- package/dist/assets/templates/templates/debug-subagent-prompt.md +3 -3
- package/dist/assets/templates/templates/discovery.md +2 -2
- package/dist/assets/templates/templates/phase-prompt.md +2 -2
- package/dist/assets/templates/templates/planner-subagent-prompt.md +7 -7
- package/dist/assets/templates/templates/project.md +1 -1
- package/dist/assets/templates/templates/research.md +1 -1
- package/dist/assets/templates/templates/state.md +2 -2
- package/dist/assets/templates/templates/summary.md +41 -0
- package/dist/assets/templates/workflows/batch.md +5 -5
- package/dist/assets/templates/workflows/diagnose-issues.md +2 -2
- package/dist/assets/templates/workflows/discovery-phase.md +3 -3
- package/dist/assets/templates/workflows/discuss-phase.md +11 -11
- package/dist/assets/templates/workflows/execute-phase.md +205 -11
- package/dist/assets/templates/workflows/execute-plan.md +299 -34
- package/dist/assets/templates/workflows/execute.md +421 -0
- package/dist/assets/templates/workflows/go.md +250 -0
- package/dist/assets/templates/workflows/health.md +5 -5
- package/dist/assets/templates/workflows/help.md +165 -435
- package/dist/assets/templates/workflows/init-existing.md +23 -23
- package/dist/assets/templates/workflows/init.md +205 -0
- package/dist/assets/templates/workflows/new-milestone.md +9 -9
- package/dist/assets/templates/workflows/new-project.md +26 -26
- package/dist/assets/templates/workflows/plan-create.md +298 -0
- package/dist/assets/templates/workflows/plan-discuss.md +347 -0
- package/dist/assets/templates/workflows/plan-phase.md +29 -29
- package/dist/assets/templates/workflows/plan-research.md +177 -0
- package/dist/assets/templates/workflows/plan.md +231 -0
- package/dist/assets/templates/workflows/progress.md +46 -42
- package/dist/assets/templates/workflows/quick.md +195 -14
- package/dist/assets/templates/workflows/research-phase.md +5 -5
- package/dist/assets/templates/workflows/sdd.md +20 -12
- package/dist/assets/templates/workflows/settings.md +18 -14
- package/dist/assets/templates/workflows/verify-phase.md +1 -1
- package/dist/assets/templates/workflows/verify-work.md +16 -16
- package/dist/cli.cjs +4589 -229
- package/dist/cli.cjs.map +1 -1
- package/dist/core-D5zUr9cb.cjs.map +1 -1
- package/dist/install.cjs +234 -17
- package/dist/install.cjs.map +1 -1
- package/dist/mcp-server.cjs +298 -20
- package/dist/mcp-server.cjs.map +1 -1
- package/dist/skills-CjFWZIGM.cjs.map +1 -1
- package/package.json +1 -1
- package/dist/assets/hooks/maxsim-context-monitor.cjs +0 -121
- package/dist/assets/hooks/maxsim-context-monitor.cjs.map +0 -1
- package/dist/assets/templates/agents/maxsim-code-reviewer.md +0 -239
- package/dist/assets/templates/agents/maxsim-codebase-mapper.md +0 -214
- package/dist/assets/templates/agents/maxsim-debugger.md +0 -572
- package/dist/assets/templates/agents/maxsim-drift-checker.md +0 -522
- package/dist/assets/templates/agents/maxsim-executor.md +0 -504
- package/dist/assets/templates/agents/maxsim-integration-checker.md +0 -273
- package/dist/assets/templates/agents/maxsim-phase-researcher.md +0 -305
- package/dist/assets/templates/agents/maxsim-plan-checker.md +0 -343
- package/dist/assets/templates/agents/maxsim-planner.md +0 -610
- package/dist/assets/templates/agents/maxsim-project-researcher.md +0 -359
- package/dist/assets/templates/agents/maxsim-research-synthesizer.md +0 -263
- package/dist/assets/templates/agents/maxsim-roadmapper.md +0 -324
- package/dist/assets/templates/agents/maxsim-spec-reviewer.md +0 -245
- package/dist/assets/templates/agents/maxsim-verifier.md +0 -393
- package/dist/assets/templates/commands/maxsim/add-phase.md +0 -43
- package/dist/assets/templates/commands/maxsim/add-tests.md +0 -41
- package/dist/assets/templates/commands/maxsim/add-todo.md +0 -57
- package/dist/assets/templates/commands/maxsim/artefakte.md +0 -122
- package/dist/assets/templates/commands/maxsim/audit-milestone.md +0 -36
- package/dist/assets/templates/commands/maxsim/batch.md +0 -42
- package/dist/assets/templates/commands/maxsim/check-drift.md +0 -56
- package/dist/assets/templates/commands/maxsim/check-todos.md +0 -46
- package/dist/assets/templates/commands/maxsim/cleanup.md +0 -18
- package/dist/assets/templates/commands/maxsim/complete-milestone.md +0 -136
- package/dist/assets/templates/commands/maxsim/discuss-phase.md +0 -87
- package/dist/assets/templates/commands/maxsim/discuss.md +0 -70
- package/dist/assets/templates/commands/maxsim/execute-phase.md +0 -41
- package/dist/assets/templates/commands/maxsim/health.md +0 -22
- package/dist/assets/templates/commands/maxsim/init-existing.md +0 -46
- package/dist/assets/templates/commands/maxsim/insert-phase.md +0 -32
- package/dist/assets/templates/commands/maxsim/list-phase-assumptions.md +0 -46
- package/dist/assets/templates/commands/maxsim/map-codebase.md +0 -71
- package/dist/assets/templates/commands/maxsim/new-milestone.md +0 -44
- package/dist/assets/templates/commands/maxsim/new-project.md +0 -46
- package/dist/assets/templates/commands/maxsim/pause-work.md +0 -38
- package/dist/assets/templates/commands/maxsim/plan-milestone-gaps.md +0 -34
- package/dist/assets/templates/commands/maxsim/plan-phase.md +0 -44
- package/dist/assets/templates/commands/maxsim/realign.md +0 -39
- package/dist/assets/templates/commands/maxsim/reapply-patches.md +0 -110
- package/dist/assets/templates/commands/maxsim/remove-phase.md +0 -31
- package/dist/assets/templates/commands/maxsim/research-phase.md +0 -189
- package/dist/assets/templates/commands/maxsim/resume-work.md +0 -40
- package/dist/assets/templates/commands/maxsim/roadmap.md +0 -19
- package/dist/assets/templates/commands/maxsim/sdd.md +0 -39
- package/dist/assets/templates/commands/maxsim/set-profile.md +0 -34
- package/dist/assets/templates/commands/maxsim/update.md +0 -37
- package/dist/assets/templates/commands/maxsim/verify-work.md +0 -38
- package/dist/assets/templates/workflows/add-phase.md +0 -111
- package/dist/assets/templates/workflows/add-tests.md +0 -351
- package/dist/assets/templates/workflows/add-todo.md +0 -247
- package/dist/assets/templates/workflows/audit-milestone.md +0 -297
- package/dist/assets/templates/workflows/check-drift.md +0 -248
- package/dist/assets/templates/workflows/check-todos.md +0 -261
- package/dist/assets/templates/workflows/cleanup.md +0 -153
- package/dist/assets/templates/workflows/complete-milestone.md +0 -701
- package/dist/assets/templates/workflows/discuss.md +0 -343
- package/dist/assets/templates/workflows/insert-phase.md +0 -129
- package/dist/assets/templates/workflows/list-phase-assumptions.md +0 -178
- package/dist/assets/templates/workflows/map-codebase.md +0 -315
- package/dist/assets/templates/workflows/pause-work.md +0 -122
- package/dist/assets/templates/workflows/plan-milestone-gaps.md +0 -274
- package/dist/assets/templates/workflows/realign.md +0 -288
- package/dist/assets/templates/workflows/remove-phase.md +0 -154
- package/dist/assets/templates/workflows/resume-project.md +0 -306
- package/dist/assets/templates/workflows/roadmap.md +0 -130
- package/dist/assets/templates/workflows/set-profile.md +0 -81
- package/dist/assets/templates/workflows/transition.md +0 -544
- package/dist/assets/templates/workflows/update.md +0 -220
|
@@ -1,33 +1,38 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: brainstorming
|
|
3
3
|
description: >-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
Multi-approach exploration before design decisions. Generates 3+ approaches
|
|
5
|
+
with tradeoff analysis before selecting. Use when facing architectural
|
|
6
|
+
choices, library selection, design decisions, or any problem with multiple
|
|
7
|
+
viable solutions.
|
|
7
8
|
---
|
|
8
9
|
|
|
9
10
|
# Brainstorming
|
|
10
11
|
|
|
11
12
|
The first idea is rarely the best idea. Explore the space before committing to a direction.
|
|
12
13
|
|
|
13
|
-
**HARD GATE** -- No implementation without design approval. If you have not presented approaches, discussed trade-offs, and received explicit user approval, you cannot write implementation code. This is not a judgment call.
|
|
14
|
-
|
|
15
14
|
## Process
|
|
16
15
|
|
|
17
16
|
### 1. Frame the Problem
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
Define the problem clearly before proposing solutions:
|
|
20
19
|
|
|
21
20
|
- What is the goal? What does success look like?
|
|
22
21
|
- What are the constraints (performance, compatibility, timeline)?
|
|
23
22
|
- What has been tried or considered already?
|
|
24
23
|
- What are the non-negotiables vs. nice-to-haves?
|
|
25
24
|
|
|
25
|
+
Ask the user ONE question at a time. Each answer informs the next question.
|
|
26
|
+
|
|
26
27
|
### 2. Research Context
|
|
27
28
|
|
|
28
|
-
Before proposing solutions, gather evidence
|
|
29
|
+
Before proposing solutions, gather evidence:
|
|
29
30
|
|
|
30
|
-
|
|
31
|
+
- Read relevant code and check for prior decisions
|
|
32
|
+
- Identify patterns already in use in the codebase
|
|
33
|
+
- Check STATE.md for existing architectural decisions
|
|
34
|
+
|
|
35
|
+
### 3. Present 3+ Approaches
|
|
31
36
|
|
|
32
37
|
For each approach, provide:
|
|
33
38
|
|
|
@@ -35,55 +40,62 @@ For each approach, provide:
|
|
|
35
40
|
|--------|---------|
|
|
36
41
|
| **Summary** | One sentence |
|
|
37
42
|
| **How it works** | 3-5 implementation bullets |
|
|
38
|
-
| **Pros** | Concrete advantages (
|
|
43
|
+
| **Pros** | Concrete advantages ("200 fewer lines" beats "simpler") |
|
|
39
44
|
| **Cons** | Honest drawbacks -- do not hide weaknesses |
|
|
40
45
|
| **Effort** | Low / Medium / High |
|
|
41
46
|
| **Risk** | What could go wrong and how recoverable |
|
|
42
47
|
|
|
43
|
-
|
|
48
|
+
If one approach is clearly superior, say so -- but still present alternatives so the user can validate your reasoning.
|
|
44
49
|
|
|
45
50
|
### 4. Discuss and Refine
|
|
46
51
|
|
|
47
|
-
Ask
|
|
52
|
+
- Ask which approach the user prefers or whether they want a hybrid
|
|
53
|
+
- Answer follow-up questions honestly
|
|
54
|
+
- If no approach fits, propose new ones informed by the discussion
|
|
55
|
+
- Continue one question at a time -- do not assume consensus
|
|
48
56
|
|
|
49
57
|
### 5. Get Explicit Approval
|
|
50
58
|
|
|
51
|
-
The user must explicitly approve one approach (e.g., "Go with A", "Approved"
|
|
59
|
+
The user must explicitly approve one approach (e.g., "Go with A", "Approved"). Vague responses like "Sounds good" or "Interesting" are not approval. If ambiguous, ask: "To confirm -- should I proceed with [specific approach]?"
|
|
52
60
|
|
|
53
61
|
### 6. Document the Decision
|
|
54
62
|
|
|
55
|
-
Record
|
|
63
|
+
Record: chosen approach, rejected alternatives with reasons, key implementation decisions, and risks.
|
|
56
64
|
|
|
57
|
-
|
|
65
|
+
## Output Format
|
|
58
66
|
|
|
59
|
-
|
|
67
|
+
```markdown
|
|
68
|
+
## Problem Statement
|
|
69
|
+
[What needs to be decided]
|
|
60
70
|
|
|
61
|
-
##
|
|
71
|
+
## Approaches
|
|
62
72
|
|
|
63
|
-
|
|
|
64
|
-
|
|
65
|
-
|
|
|
66
|
-
|
|
|
67
|
-
|
|
|
73
|
+
| # | Approach | Effort | Risk |
|
|
74
|
+
|---|----------|--------|------|
|
|
75
|
+
| A | [summary] | Low/Med/High | Low/Med/High |
|
|
76
|
+
| B | [summary] | Low/Med/High | Low/Med/High |
|
|
77
|
+
| C | [summary] | Low/Med/High | Low/Med/High |
|
|
68
78
|
|
|
69
|
-
|
|
79
|
+
### Approach A: [name]
|
|
80
|
+
[How it works, pros, cons]
|
|
70
81
|
|
|
71
|
-
|
|
82
|
+
### Approach B: [name]
|
|
83
|
+
[How it works, pros, cons]
|
|
72
84
|
|
|
73
|
-
|
|
85
|
+
### Approach C: [name]
|
|
86
|
+
[How it works, pros, cons]
|
|
74
87
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
- [ ] Decision has been recorded
|
|
80
|
-
- [ ] Design doc captures chosen approach, rejected alternatives, and risks
|
|
88
|
+
## Selected: [letter]
|
|
89
|
+
**Rationale:** [why this approach was chosen]
|
|
90
|
+
**Rejected:** [why alternatives were not chosen]
|
|
91
|
+
```
|
|
81
92
|
|
|
82
|
-
##
|
|
93
|
+
## Common Pitfalls
|
|
83
94
|
|
|
84
|
-
|
|
95
|
+
| Excuse | Reality |
|
|
96
|
+
|--------|---------|
|
|
97
|
+
| "I already know the best approach" | You know your preferred approach. Alternatives may be better. |
|
|
98
|
+
| "There's only one way to do this" | There is almost never only one way. |
|
|
99
|
+
| "Brainstorming slows us down" | Building the wrong thing is slower. 30 minutes of design saves days of rework. |
|
|
85
100
|
|
|
86
|
-
|
|
87
|
-
- Use before any task introducing new architecture, patterns, or external dependencies
|
|
88
|
-
- Decision records in STATE.md persist across sessions -- future agents inherit context
|
|
89
|
-
- If a session spans multiple interactions, record partial progress in STATE.md blockers
|
|
101
|
+
Stop immediately if you catch yourself writing code before presenting approaches, presenting only one option, asking multiple questions at once, or assuming approval without explicit confirmation.
|
|
@@ -1,33 +1,28 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: code-review
|
|
3
3
|
description: >-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
pass — that is maxsim-simplify's job.
|
|
4
|
+
Code quality review covering security, interfaces, error handling, test
|
|
5
|
+
coverage, and conventions. Produces structured findings with severity and
|
|
6
|
+
evidence. Use when reviewing pull requests, completed implementations, or
|
|
7
|
+
code changes.
|
|
9
8
|
---
|
|
10
9
|
|
|
11
10
|
# Code Review
|
|
12
11
|
|
|
13
12
|
Shipping unreviewed code is shipping unknown risk. Review before sign-off.
|
|
14
13
|
|
|
15
|
-
|
|
14
|
+
## Review Dimensions
|
|
16
15
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
Follow these steps in order before approving any phase or significant implementation.
|
|
16
|
+
Follow these dimensions in order for every review.
|
|
20
17
|
|
|
21
18
|
### 1. SCOPE -- Identify All Changes
|
|
22
19
|
|
|
23
|
-
- Diff against the
|
|
20
|
+
- Diff against the starting point to see every changed file
|
|
24
21
|
- List all new, modified, and deleted files
|
|
25
22
|
- Do not skip generated files, config changes, or minor edits
|
|
26
23
|
|
|
27
24
|
### 2. SECURITY -- Check for Vulnerabilities
|
|
28
25
|
|
|
29
|
-
Review every changed file for:
|
|
30
|
-
|
|
31
26
|
| Category | What to Look For |
|
|
32
27
|
|----------|-----------------|
|
|
33
28
|
| Injection | Unsanitized user input in SQL, shell commands, HTML output, template strings |
|
|
@@ -36,7 +31,7 @@ Review every changed file for:
|
|
|
36
31
|
| Data exposure | Secrets in logs, overly broad API responses, sensitive data in error messages |
|
|
37
32
|
| Dependencies | New dependencies with known vulnerabilities, unnecessary dependencies |
|
|
38
33
|
|
|
39
|
-
|
|
34
|
+
Any security issue is a blocking finding. No exceptions.
|
|
40
35
|
|
|
41
36
|
### 3. INTERFACES -- Verify API Contracts
|
|
42
37
|
|
|
@@ -44,7 +39,6 @@ Review every changed file for:
|
|
|
44
39
|
- Are return types accurate and complete?
|
|
45
40
|
- Do error types cover all failure modes?
|
|
46
41
|
- Are breaking changes documented and intentional?
|
|
47
|
-
- Do exported interfaces maintain backward compatibility?
|
|
48
42
|
|
|
49
43
|
### 4. ERROR HANDLING -- Check Failure Paths
|
|
50
44
|
|
|
@@ -60,51 +54,13 @@ Review every changed file for:
|
|
|
60
54
|
- Are edge cases tested?
|
|
61
55
|
- Do tests verify behavior, not implementation details?
|
|
62
56
|
|
|
63
|
-
### 6.
|
|
57
|
+
### 6. CONVENTIONS -- Assess Compliance
|
|
64
58
|
|
|
65
59
|
- Is naming consistent with existing codebase conventions?
|
|
66
|
-
- Are there duplication opportunities that should be extracted?
|
|
67
60
|
- Is the complexity justified by the requirements?
|
|
68
61
|
- Are comments present where logic is non-obvious?
|
|
69
62
|
|
|
70
|
-
##
|
|
71
|
-
|
|
72
|
-
| Issue | Reality |
|
|
73
|
-
|-------|---------|
|
|
74
|
-
| "Tests pass, so the code is fine" | Tests verify behavior, not code quality. Review is separate. |
|
|
75
|
-
| "I wrote it, so I know it's correct" | Author bias is real. Review as if someone else wrote it. |
|
|
76
|
-
| "It's just a small change" | Small changes cause large outages. |
|
|
77
|
-
| "Generated code doesn't need review" | Generated code has the same bugs. Review it. |
|
|
78
|
-
|
|
79
|
-
Stop if you catch yourself skipping files because they "look fine," approving without reading actual code, or rushing through review to meet a deadline.
|
|
80
|
-
|
|
81
|
-
## Verification
|
|
82
|
-
|
|
83
|
-
Before signing off on a phase, confirm:
|
|
84
|
-
|
|
85
|
-
- [ ] All changed files have been reviewed (not just the "important" ones)
|
|
86
|
-
- [ ] No security vulnerabilities found (or all found issues resolved)
|
|
87
|
-
- [ ] Public interfaces match their contracts and documentation
|
|
88
|
-
- [ ] Error handling covers all external calls and edge cases
|
|
89
|
-
- [ ] Test coverage exists for new public functions and error paths
|
|
90
|
-
- [ ] Naming and style are consistent with codebase conventions
|
|
91
|
-
- [ ] No blocker or high severity issues remain open
|
|
92
|
-
|
|
93
|
-
### Severity Reference
|
|
94
|
-
|
|
95
|
-
| Severity | Category | Example |
|
|
96
|
-
|----------|----------|---------|
|
|
97
|
-
| Blocker | Security vulnerability | SQL injection, XSS, hardcoded secrets |
|
|
98
|
-
| Blocker | Broken interface | Public API returns wrong type |
|
|
99
|
-
| Blocker | Data loss risk | Destructive operation without confirmation |
|
|
100
|
-
| High | Performance regression | O(n^2) where O(n) is trivial |
|
|
101
|
-
| High | Missing critical tests | No tests for error paths or new public API |
|
|
102
|
-
| Medium | Naming inconsistency | Convention mismatch with existing codebase |
|
|
103
|
-
| Medium | Dead code | Unreachable branches, unused imports |
|
|
104
|
-
|
|
105
|
-
Blocker and High severity issues block sign-off. Medium issues should be filed for follow-up.
|
|
106
|
-
|
|
107
|
-
### Review Output Format
|
|
63
|
+
## Review Output Format
|
|
108
64
|
|
|
109
65
|
```
|
|
110
66
|
REVIEW SCOPE: [number] files changed, [number] additions, [number] deletions
|
|
@@ -112,14 +68,37 @@ SECURITY: PASS | ISSUES FOUND (list)
|
|
|
112
68
|
INTERFACES: PASS | ISSUES FOUND (list)
|
|
113
69
|
ERROR HANDLING: PASS | ISSUES FOUND (list)
|
|
114
70
|
TEST COVERAGE: PASS | GAPS FOUND (list)
|
|
115
|
-
|
|
71
|
+
CONVENTIONS: PASS | ISSUES FOUND (list)
|
|
116
72
|
VERDICT: APPROVED | BLOCKED (list blocking issues)
|
|
117
73
|
```
|
|
118
74
|
|
|
119
|
-
|
|
75
|
+
### Severity Reference
|
|
76
|
+
|
|
77
|
+
| Severity | Examples |
|
|
78
|
+
|----------|---------|
|
|
79
|
+
| Blocker | SQL injection, XSS, hardcoded secrets, broken public API, data loss risk |
|
|
80
|
+
| High | Performance regression, missing critical tests, no error path tests |
|
|
81
|
+
| Medium | Naming inconsistency, dead code, convention mismatch |
|
|
82
|
+
|
|
83
|
+
Blocker and High severity issues block approval. Medium issues should be filed for follow-up.
|
|
84
|
+
|
|
85
|
+
## Spec Review vs Code Review
|
|
86
|
+
|
|
87
|
+
| Dimension | Spec Review | Code Review |
|
|
88
|
+
|-----------|------------|-------------|
|
|
89
|
+
| Question | Does it match the requirements? | Is the code correct and quality? |
|
|
90
|
+
| Checks | Acceptance criteria, requirement coverage, scope | Security, interfaces, errors, tests, conventions |
|
|
91
|
+
| Output | PASS/FAIL per requirement | APPROVED/BLOCKED per dimension |
|
|
92
|
+
|
|
93
|
+
Both reviews are needed -- spec review alone does not catch security issues, and code review alone does not catch missing requirements.
|
|
94
|
+
|
|
95
|
+
## Common Pitfalls
|
|
96
|
+
|
|
97
|
+
| Issue | Reality |
|
|
98
|
+
|-------|---------|
|
|
99
|
+
| "Tests pass, so the code is fine" | Tests verify behavior, not code quality. Review is separate. |
|
|
100
|
+
| "I wrote it, so I know it's correct" | Author bias is real. Review as if someone else wrote it. |
|
|
101
|
+
| "It's just a small change" | Small changes cause large outages. |
|
|
102
|
+
| "Generated code doesn't need review" | Generated code has the same bugs. Review it. |
|
|
120
103
|
|
|
121
|
-
|
|
122
|
-
- After all tasks in a phase are complete, run this review before marking the phase done
|
|
123
|
-
- Blocking issues must be resolved before phase completion
|
|
124
|
-
- Medium issues should be captured as todos for the next phase
|
|
125
|
-
- The review summary should be included in the phase SUMMARY.md
|
|
104
|
+
See also: `/maxsim-simplify` for maintainability optimization (duplication, dead code, complexity).
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: commit-conventions
|
|
3
|
+
description: >-
|
|
4
|
+
Commit message format using conventional commits with scope. Defines atomic
|
|
5
|
+
commit rules, breaking change markers, and co-author attribution for
|
|
6
|
+
AI-assisted work. Use when creating git commits, reviewing commit messages,
|
|
7
|
+
or establishing commit conventions for a project.
|
|
8
|
+
user-invocable: false
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Commit Conventions
|
|
12
|
+
|
|
13
|
+
Consistent commit messages that enable automated versioning, changelogs, and clear project history.
|
|
14
|
+
|
|
15
|
+
## Conventional Commit Format
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
{type}({scope}): {description}
|
|
19
|
+
|
|
20
|
+
- {key change 1}
|
|
21
|
+
- {key change 2}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Types
|
|
25
|
+
|
|
26
|
+
| Type | When | Triggers |
|
|
27
|
+
|------|------|---------|
|
|
28
|
+
| `feat` | New feature or capability | Minor version bump |
|
|
29
|
+
| `fix` | Bug fix | Patch version bump |
|
|
30
|
+
| `chore` | Build, deps, config, maintenance | No version bump |
|
|
31
|
+
| `docs` | Documentation only | No version bump |
|
|
32
|
+
| `test` | Adding or fixing tests | No version bump |
|
|
33
|
+
| `refactor` | Code change that's neither fix nor feature | No version bump |
|
|
34
|
+
|
|
35
|
+
### Breaking Changes
|
|
36
|
+
|
|
37
|
+
Append `!` after the type for breaking changes:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
feat!(install): require Node 20 minimum
|
|
41
|
+
fix!(config): rename model_profile to profile
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Breaking changes trigger a major version bump.
|
|
45
|
+
|
|
46
|
+
### Scope
|
|
47
|
+
|
|
48
|
+
Scope identifies the area of change:
|
|
49
|
+
|
|
50
|
+
- Phase work: `feat(04-01):`, `fix(phase-04):`
|
|
51
|
+
- Module: `fix(install):`, `refactor(core):`
|
|
52
|
+
- Component: `feat(dashboard):`, `test(cli):`
|
|
53
|
+
|
|
54
|
+
## Atomic Commits
|
|
55
|
+
|
|
56
|
+
One logical change per commit:
|
|
57
|
+
|
|
58
|
+
- **DO:** Separate feature implementation from test additions
|
|
59
|
+
- **DO:** Commit each task in a plan individually
|
|
60
|
+
- **DO NOT:** Bundle unrelated changes in one commit
|
|
61
|
+
- **DO NOT:** Include "fix typo" changes in feature commits
|
|
62
|
+
|
|
63
|
+
## Co-Author Attribution
|
|
64
|
+
|
|
65
|
+
When work is AI-assisted, include the co-author line:
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
Co-Authored-By: Claude <noreply@anthropic.com>
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Commit Message Guidelines
|
|
72
|
+
|
|
73
|
+
- **Subject line:** Under 72 characters, imperative mood ("add" not "added")
|
|
74
|
+
- **Body:** Bullet points for key changes (optional for small commits)
|
|
75
|
+
- **Why over what:** The diff shows what changed; the message explains why
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: evidence-collection
|
|
3
|
+
description: >-
|
|
4
|
+
Systematic evidence gathering using tool output before making claims. Covers
|
|
5
|
+
what counts as evidence, the collection process, and common pitfalls that lead
|
|
6
|
+
to false claims. Use when verifying work completion, checking test results,
|
|
7
|
+
validating build success, or before any completion gate.
|
|
8
|
+
user-invocable: false
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Evidence Collection
|
|
12
|
+
|
|
13
|
+
Gather fresh evidence using tool output before making any claim. Evidence must come from THIS turn -- not prior turns, not cached knowledge, not reasoning.
|
|
14
|
+
|
|
15
|
+
## Collection Process
|
|
16
|
+
|
|
17
|
+
For each claim you need to support:
|
|
18
|
+
|
|
19
|
+
1. **IDENTIFY** -- What command proves this claim?
|
|
20
|
+
- Pick the most direct verification (e.g., `npm test` for "tests pass", not "I wrote the test")
|
|
21
|
+
- If no single command exists, identify all required checks
|
|
22
|
+
|
|
23
|
+
2. **RUN** -- Execute the command fresh in THIS turn
|
|
24
|
+
- Do not reuse output from a previous turn
|
|
25
|
+
- Do not rely on output from a different command
|
|
26
|
+
- Run the full command, not a partial check
|
|
27
|
+
|
|
28
|
+
3. **READ** -- Read the complete output
|
|
29
|
+
- Check the exit code (0 = success, non-zero = failure)
|
|
30
|
+
- Read all output, not just the summary line
|
|
31
|
+
- Look for warnings or partial failures hidden in verbose output
|
|
32
|
+
|
|
33
|
+
4. **CHECK** -- Does the output actually confirm the claim?
|
|
34
|
+
- Match output against specific expected values
|
|
35
|
+
- A passing build does not mean passing tests
|
|
36
|
+
- A created file does not mean correct file contents
|
|
37
|
+
|
|
38
|
+
5. **CITE** -- Include the evidence in your response
|
|
39
|
+
- Use the evidence block format
|
|
40
|
+
- Quote specific output lines, not paraphrased summaries
|
|
41
|
+
|
|
42
|
+
## What Counts as Evidence
|
|
43
|
+
|
|
44
|
+
| Claim | Requires | Not Sufficient |
|
|
45
|
+
|-------|----------|----------------|
|
|
46
|
+
| "Tests pass" | Test command output showing 0 failures | Previous run, "should pass", partial run |
|
|
47
|
+
| "Build succeeds" | Build command with exit code 0 | Linter passing, "logs look clean" |
|
|
48
|
+
| "Bug is fixed" | Original failing test now passes | "Code changed, assumed fixed" |
|
|
49
|
+
| "Task complete" | All done criteria checked with evidence | "I implemented everything in the plan" |
|
|
50
|
+
| "No regressions" | Full test suite passing | "I only changed one file" |
|
|
51
|
+
| "File created" | Read tool or `test -f` output | "I ran the Write tool" (verify it wrote) |
|
|
52
|
+
| "Content correct" | Read tool showing expected content | "I wrote the correct content" |
|
|
53
|
+
| "API responds" | curl/fetch output with status code | "Server is running" without calling it |
|
|
54
|
+
|
|
55
|
+
## Evidence Block Format
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
CLAIM: [what you are claiming]
|
|
59
|
+
EVIDENCE: [exact command run in THIS turn]
|
|
60
|
+
OUTPUT: [relevant excerpt of actual output]
|
|
61
|
+
VERDICT: PASS | FAIL
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Common Pitfalls
|
|
65
|
+
|
|
66
|
+
| Excuse | Why It Fails |
|
|
67
|
+
|--------|-------------|
|
|
68
|
+
| "Should work now" | "Should" is not evidence. Run the command. |
|
|
69
|
+
| "I'm confident in the logic" | Confidence is not evidence. Run it. |
|
|
70
|
+
| "The linter passed" | Linter passing does not mean tests pass or build succeeds. |
|
|
71
|
+
| "I only changed one line" | One line can break everything. Verify. |
|
|
72
|
+
| "The subagent reported success" | Trust test output and VCS diffs, not agent reports. |
|
|
73
|
+
| "I already checked this" | In a previous turn. Evidence expires each turn. Run it again. |
|
|
74
|
+
| "The error was in a different file" | Side effects cross files. Run the full suite. |
|
|
75
|
+
| "It compiled, so it works" | Compilation checks types, not logic. Run tests. |
|
|
76
|
+
|
|
77
|
+
## Key Rules
|
|
78
|
+
|
|
79
|
+
- **THIS-turn only**: Evidence from prior turns is stale. Always re-run.
|
|
80
|
+
- **Tool output only**: Your reasoning, analysis, and confidence are not evidence.
|
|
81
|
+
- **Full output**: Read the complete output, not just the first or last line.
|
|
82
|
+
- **Specific citations**: Quote the output. "It passed" is not a citation.
|
|
83
|
+
- **One block per claim**: Each distinct claim needs its own evidence or an explicit grouping note.
|
|
84
|
+
|
|
85
|
+
## See Also
|
|
86
|
+
|
|
87
|
+
The `verification-gates` skill defines the gate framework where evidence collection is applied. The always-loaded `verification-protocol` rule provides the enforcement language.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: handoff-contract
|
|
3
|
+
description: >-
|
|
4
|
+
Structured return format for agent handoffs. Defines Key Decisions, Artifacts,
|
|
5
|
+
Status, and Deferred Items sections that every agent must include when returning
|
|
6
|
+
results. Use when completing any agent task, returning results to orchestrator,
|
|
7
|
+
or transitioning between workflow stages.
|
|
8
|
+
user-invocable: false
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Handoff Contract
|
|
12
|
+
|
|
13
|
+
Every agent returns results using this structured format. The orchestrator depends on these sections for state tracking, artifact management, and pipeline decisions.
|
|
14
|
+
|
|
15
|
+
## Required Return Sections
|
|
16
|
+
|
|
17
|
+
### Key Decisions
|
|
18
|
+
|
|
19
|
+
Document decisions made during execution that affect downstream work:
|
|
20
|
+
|
|
21
|
+
```markdown
|
|
22
|
+
### Key Decisions
|
|
23
|
+
- Chose X over Y because [reason]
|
|
24
|
+
- Deferred Z to [phase/plan] because [reason]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Include: technology choices, scope adjustments, interpretation of ambiguous requirements. Omit: routine implementation details.
|
|
28
|
+
|
|
29
|
+
### Artifacts
|
|
30
|
+
|
|
31
|
+
List all files created or modified, grouped by action:
|
|
32
|
+
|
|
33
|
+
```markdown
|
|
34
|
+
### Artifacts
|
|
35
|
+
- Created: path/to/new-file.ts
|
|
36
|
+
- Created: path/to/another-file.md
|
|
37
|
+
- Modified: path/to/existing-file.ts
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Use absolute paths from project root. Include every file touched, not just the primary deliverables.
|
|
41
|
+
|
|
42
|
+
### Status
|
|
43
|
+
|
|
44
|
+
One of three values:
|
|
45
|
+
|
|
46
|
+
| Status | Meaning | Orchestrator Action |
|
|
47
|
+
|--------|---------|-------------------|
|
|
48
|
+
| `complete` | All tasks done, verification passed | Advance to next plan or stage |
|
|
49
|
+
| `blocked` | Cannot proceed without external input | Present blocker to user, await resolution |
|
|
50
|
+
| `partial` | Some tasks done, stopped at checkpoint | Resume from checkpoint with user input |
|
|
51
|
+
|
|
52
|
+
```markdown
|
|
53
|
+
### Status
|
|
54
|
+
complete
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Deferred Items
|
|
58
|
+
|
|
59
|
+
Work discovered but not implemented (outside current scope):
|
|
60
|
+
|
|
61
|
+
```markdown
|
|
62
|
+
### Deferred Items
|
|
63
|
+
- [feature] Add caching layer -- not in current plan scope
|
|
64
|
+
- [bug] Race condition in parallel writes -- needs investigation
|
|
65
|
+
- [refactor] Extract shared validation logic -- deferred to Phase 5
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
If none: `### Deferred Items\nNone`
|
|
69
|
+
|
|
70
|
+
Categories: `feature`, `bug`, `refactor`, `investigation`
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: input-validation
|
|
3
|
+
description: >-
|
|
4
|
+
Validates required inputs exist before agent work begins. Checks file paths,
|
|
5
|
+
environment variables, and CLI arguments at startup. Use at agent startup to
|
|
6
|
+
fail fast with structured error instead of proceeding with missing context.
|
|
7
|
+
user-invocable: false
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Input Validation
|
|
11
|
+
|
|
12
|
+
Validate all required inputs before doing any work. Fail fast with a structured error -- never attempt partial work with missing context.
|
|
13
|
+
|
|
14
|
+
## Process
|
|
15
|
+
|
|
16
|
+
At agent startup, before any implementation:
|
|
17
|
+
|
|
18
|
+
1. **List required inputs** -- files, env vars, CLI args, state files
|
|
19
|
+
2. **Check each input exists** -- use tool calls, not assumptions
|
|
20
|
+
3. **Collect all missing inputs** -- do not stop at the first missing item
|
|
21
|
+
4. **If any missing: return structured error immediately**
|
|
22
|
+
|
|
23
|
+
## Structured Error Format
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
AGENT RESULT: INPUT VALIDATION FAILED
|
|
27
|
+
|
|
28
|
+
Missing:
|
|
29
|
+
- [input 1] -- [what it is, where it should come from]
|
|
30
|
+
- [input 2] -- [what it is, where it should come from]
|
|
31
|
+
|
|
32
|
+
Expected from: [source -- orchestrator spawn prompt, user environment, prior agent output]
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Validation Checks by Type
|
|
36
|
+
|
|
37
|
+
| Input Type | How to Check | Example |
|
|
38
|
+
|-----------|-------------|---------|
|
|
39
|
+
| File path | `test -f "path"` or Read tool | PLAN.md, STATE.md, config.json |
|
|
40
|
+
| Directory | `test -d "path"` | .planning/, templates/ |
|
|
41
|
+
| Env variable | `echo "$VAR"` or `test -n "$VAR"` | GITHUB_TOKEN, NODE_ENV |
|
|
42
|
+
| CLI argument | Check prompt context for required fields | Phase number, plan number |
|
|
43
|
+
| Prior output | Check expected file or git commit exists | SUMMARY.md from previous plan |
|
|
44
|
+
|
|
45
|
+
## Rules
|
|
46
|
+
|
|
47
|
+
- **Check ALL inputs before reporting** -- collect the complete list of missing items
|
|
48
|
+
- **Do NOT attempt partial work** -- if inputs are missing, the output will be wrong
|
|
49
|
+
- **Do NOT guess missing values** -- return the error and let the orchestrator fix it
|
|
50
|
+
- **Include the source** -- tell the user where the missing input should come from
|
|
51
|
+
- **This is a hard gate** -- no workarounds, no "I'll proceed without it"
|