vector-cadence-skills 0.1.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 +10 -0
- package/CONTRIBUTING.md +69 -0
- package/DOCUMENTATION.md +1081 -0
- package/README.md +146 -0
- package/examples/bug-debug-lifecycle.md +39 -0
- package/examples/feature-lifecycle.md +54 -0
- package/examples/harness-subagent-plan.md +39 -0
- package/examples/vertical-slices.md +43 -0
- package/package.json +39 -0
- package/references/architecture-overview.md +279 -0
- package/references/artifact-model.md +20 -0
- package/references/final-skill-quality-bar.md +33 -0
- package/references/minimal-mode.md +50 -0
- package/references/source-integration-map.md +159 -0
- package/references/subagent-policy.md +30 -0
- package/references/tiering.md +23 -0
- package/scripts/validate-skills.mjs +187 -0
- package/skills/vc-align/SKILL.md +124 -0
- package/skills/vc-architecture/SKILL.md +131 -0
- package/skills/vc-debug/SKILL.md +154 -0
- package/skills/vc-execute/SKILL.md +166 -0
- package/skills/vc-handoff/SKILL.md +127 -0
- package/skills/vc-harness-architect/SKILL.md +138 -0
- package/skills/vc-learn/SKILL.md +123 -0
- package/skills/vc-orient/SKILL.md +108 -0
- package/skills/vc-plan/SKILL.md +156 -0
- package/skills/vc-prototype/SKILL.md +103 -0
- package/skills/vc-review/SKILL.md +156 -0
- package/skills/vc-setup/SKILL.md +126 -0
- package/skills/vc-skill-author/SKILL.md +131 -0
- package/skills/vc-slice/SKILL.md +121 -0
- package/skills/vc-triage/SKILL.md +149 -0
- package/skills.json +98 -0
- package/templates/AGENTS.md +82 -0
- package/templates/CONTEXT.md +23 -0
- package/templates/vc-budget.yml +4 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vc-learn
|
|
3
|
+
description: Capture durable lessons after verified work so future agents can reuse solved problems, conventions, decisions, and implementation reality. Use when finishing non-trivial bug fixes, shipped features, refactors, architecture decisions, harness improvements, or review findings with reusable lessons.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Vector Cadence Learn
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Make future work cheaper and safer by capturing only reusable lessons. This skill prevents both knowledge loss and documentation spam.
|
|
11
|
+
|
|
12
|
+
## Operating model
|
|
13
|
+
|
|
14
|
+
Write learning only when the problem is solved or diagnosed, the lesson is reusable, overlap has been checked, and the right artifact type is clear.
|
|
15
|
+
|
|
16
|
+
## When to use
|
|
17
|
+
|
|
18
|
+
Use after:
|
|
19
|
+
|
|
20
|
+
- hard bug diagnosis/fix,
|
|
21
|
+
- non-obvious implementation pattern,
|
|
22
|
+
- feature shipped with lessons,
|
|
23
|
+
- architecture decision,
|
|
24
|
+
- harness/tool/subagent integration,
|
|
25
|
+
- systemic review finding.
|
|
26
|
+
|
|
27
|
+
## When to skip
|
|
28
|
+
|
|
29
|
+
Skip when:
|
|
30
|
+
|
|
31
|
+
- the fix is trivial,
|
|
32
|
+
- the solution is unverified,
|
|
33
|
+
- no reusable lesson can be stated in one sentence,
|
|
34
|
+
- an existing doc already covers it and needs no update.
|
|
35
|
+
|
|
36
|
+
## Inputs
|
|
37
|
+
|
|
38
|
+
Use:
|
|
39
|
+
|
|
40
|
+
- execution/debug/review summary,
|
|
41
|
+
- commits/diff,
|
|
42
|
+
- tests added,
|
|
43
|
+
- linked issue/plan/requirements,
|
|
44
|
+
- existing `docs/solutions/`, `docs/knowledge/`, ADRs, and `CONTEXT.md`.
|
|
45
|
+
|
|
46
|
+
## Reusable lesson gate
|
|
47
|
+
|
|
48
|
+
Do not write a learning doc unless the lesson can be stated in one sentence and is likely to be searched for later.
|
|
49
|
+
|
|
50
|
+
Good:
|
|
51
|
+
|
|
52
|
+
> Webhook handlers must use provider event ID as the idempotency key, not invoice ID.
|
|
53
|
+
|
|
54
|
+
Bad:
|
|
55
|
+
|
|
56
|
+
> Fixed bug in webhook handler.
|
|
57
|
+
|
|
58
|
+
## Artifact routing
|
|
59
|
+
|
|
60
|
+
| Lesson type | Artifact |
|
|
61
|
+
|---|---|
|
|
62
|
+
| domain term | `CONTEXT.md` |
|
|
63
|
+
| durable trade-off | ADR |
|
|
64
|
+
| solved technical problem | `docs/solutions/<category>/<slug>.md` |
|
|
65
|
+
| feature lifecycle reality | `docs/knowledge/<feature>.md` |
|
|
66
|
+
| global agent convention | `AGENTS.md` |
|
|
67
|
+
| recurring rejected idea | `.out-of-scope/<slug>.md` |
|
|
68
|
+
|
|
69
|
+
## Workflow
|
|
70
|
+
|
|
71
|
+
### 1. Gather evidence
|
|
72
|
+
|
|
73
|
+
Read source artifacts and actual changes. Do not write from memory alone.
|
|
74
|
+
|
|
75
|
+
### 2. Check overlap
|
|
76
|
+
|
|
77
|
+
Search for similar docs by symptom, root cause, framework, module, and pattern. Update or consolidate existing docs when overlap is high.
|
|
78
|
+
|
|
79
|
+
### 3. Choose artifact
|
|
80
|
+
|
|
81
|
+
Pick the narrowest artifact that answers the future question. Do not collapse glossary, ADR, solution, and feature lifecycle information into one document.
|
|
82
|
+
|
|
83
|
+
### 4. Write concise learning
|
|
84
|
+
|
|
85
|
+
Solution docs should include:
|
|
86
|
+
|
|
87
|
+
- symptom,
|
|
88
|
+
- root cause,
|
|
89
|
+
- working solution,
|
|
90
|
+
- why it works,
|
|
91
|
+
- tests/verification,
|
|
92
|
+
- prevention,
|
|
93
|
+
- related files/docs,
|
|
94
|
+
- search keywords.
|
|
95
|
+
|
|
96
|
+
### 5. Update instructions sparingly
|
|
97
|
+
|
|
98
|
+
Update `AGENTS.md` only for conventions every future agent should follow. Link to detailed docs instead of embedding long narratives.
|
|
99
|
+
|
|
100
|
+
### 6. Refresh stale docs when needed
|
|
101
|
+
|
|
102
|
+
If docs drift or overlap, keep, update, consolidate, replace, or delete after checking retrieval value and inbound links.
|
|
103
|
+
|
|
104
|
+
## Output
|
|
105
|
+
|
|
106
|
+
```markdown
|
|
107
|
+
## Learning Summary
|
|
108
|
+
|
|
109
|
+
**Captured:** yes | no
|
|
110
|
+
**Lesson:** ...
|
|
111
|
+
**Artifacts changed:** ...
|
|
112
|
+
**Overlap handled:** none | updated | consolidated | superseded
|
|
113
|
+
**Future retrieval keywords:** ...
|
|
114
|
+
**Recommended next skill:** none | vc-align
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## Guardrails
|
|
118
|
+
|
|
119
|
+
- Do not document trivial work.
|
|
120
|
+
- Do not put implementation decisions in `CONTEXT.md`.
|
|
121
|
+
- Do not create ADRs unless the sparse ADR rule passes.
|
|
122
|
+
- Do not preserve stale docs just because deletion feels risky.
|
|
123
|
+
- Do not write multiple draft docs from subagents; write one final artifact.
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vc-orient
|
|
3
|
+
description: Map a codebase area and explain how it fits the system using code, tests, domain docs, ADRs, and prior knowledge. Use when the user is unfamiliar with code, an agent seems too deep in details, or planning/debugging needs a verified system map.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Vector Cadence Orient
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Create a read-only map of a code area so later alignment, planning, debugging, or implementation starts from reality instead of guesses.
|
|
11
|
+
|
|
12
|
+
## Operating model
|
|
13
|
+
|
|
14
|
+
Read code first, docs second. Separate verified facts from inferred patterns, stale-doc claims, and unknowns.
|
|
15
|
+
|
|
16
|
+
## When to use
|
|
17
|
+
|
|
18
|
+
Use when:
|
|
19
|
+
|
|
20
|
+
- the user asks how something works,
|
|
21
|
+
- the agent is editing without enough system context,
|
|
22
|
+
- planning needs a local map,
|
|
23
|
+
- debugging needs data/control flow,
|
|
24
|
+
- architecture review needs candidate areas,
|
|
25
|
+
- onboarding to a module.
|
|
26
|
+
|
|
27
|
+
## When to skip
|
|
28
|
+
|
|
29
|
+
Skip when:
|
|
30
|
+
|
|
31
|
+
- the user already provided enough context,
|
|
32
|
+
- the task is a clear small edit,
|
|
33
|
+
- the user wants implementation now and orientation would add no value.
|
|
34
|
+
|
|
35
|
+
## Inputs
|
|
36
|
+
|
|
37
|
+
Subject can be:
|
|
38
|
+
|
|
39
|
+
- file path,
|
|
40
|
+
- symbol/class/function,
|
|
41
|
+
- feature name,
|
|
42
|
+
- domain term,
|
|
43
|
+
- issue/plan requirement,
|
|
44
|
+
- error path.
|
|
45
|
+
|
|
46
|
+
## Workflow
|
|
47
|
+
|
|
48
|
+
### 1. Identify subject
|
|
49
|
+
|
|
50
|
+
If ambiguous, ask one clarifying question or start with the most likely subject and label uncertainty.
|
|
51
|
+
|
|
52
|
+
### 2. Read in priority order
|
|
53
|
+
|
|
54
|
+
1. Code around the subject.
|
|
55
|
+
2. Callers/callees and adjacent modules.
|
|
56
|
+
3. Tests exercising the subject.
|
|
57
|
+
4. `CONTEXT.md` terms.
|
|
58
|
+
5. Relevant ADRs.
|
|
59
|
+
6. Knowledge/solution docs if relevant.
|
|
60
|
+
7. Project instructions.
|
|
61
|
+
|
|
62
|
+
### 3. Build the map
|
|
63
|
+
|
|
64
|
+
Explain:
|
|
65
|
+
|
|
66
|
+
- responsibility and non-responsibility,
|
|
67
|
+
- key files/modules,
|
|
68
|
+
- public interfaces and seams,
|
|
69
|
+
- data/control flow,
|
|
70
|
+
- important invariants,
|
|
71
|
+
- tests and verification paths,
|
|
72
|
+
- known risks or historical lessons,
|
|
73
|
+
- likely extension points.
|
|
74
|
+
|
|
75
|
+
### 4. Label confidence
|
|
76
|
+
|
|
77
|
+
Separate:
|
|
78
|
+
|
|
79
|
+
- verified from code,
|
|
80
|
+
- inferred from naming/patterns,
|
|
81
|
+
- stated in docs but not verified,
|
|
82
|
+
- unknown.
|
|
83
|
+
|
|
84
|
+
## Output
|
|
85
|
+
|
|
86
|
+
```markdown
|
|
87
|
+
## Orientation Map
|
|
88
|
+
|
|
89
|
+
**Subject:** ...
|
|
90
|
+
**Responsibility:** ...
|
|
91
|
+
**Key files:** ...
|
|
92
|
+
**Public interfaces / seams:** ...
|
|
93
|
+
**Data/control flow:** ...
|
|
94
|
+
**Domain terms:** ...
|
|
95
|
+
**Relevant tests:** ...
|
|
96
|
+
**Relevant ADRs/knowledge:** ...
|
|
97
|
+
**Risks / gotchas:** ...
|
|
98
|
+
**What to read next:** ...
|
|
99
|
+
**Recommended next skill:** vc-align | vc-plan | vc-architecture | vc-debug
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Guardrails
|
|
103
|
+
|
|
104
|
+
- Do not mutate files.
|
|
105
|
+
- Do not summarize from docs before reading code.
|
|
106
|
+
- Do not produce giant file inventories unless asked.
|
|
107
|
+
- Do not hide uncertainty.
|
|
108
|
+
- Do not create durable docs unless the user asks or future retrieval value is clear.
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vc-plan
|
|
3
|
+
description: Convert aligned intent into an implementation-ready technical plan with right-sized research, traceable units, file paths, test scenarios, and verification criteria. Use when alignment is complete or when the user asks for a technical plan, PRD-to-plan conversion, implementation strategy, or plan deepening.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Vector Cadence Plan
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Create a technical plan that an implementer can execute confidently. Planning captures decisions, files, dependencies, risks, and test scenarios; it does not write production code.
|
|
11
|
+
|
|
12
|
+
## Operating model
|
|
13
|
+
|
|
14
|
+
Use local code research first, add external or multi-agent research only when risk justifies it, and synthesize strategy, domain language, and alignment notes into a portable plan.
|
|
15
|
+
|
|
16
|
+
## When to use
|
|
17
|
+
|
|
18
|
+
Use for:
|
|
19
|
+
|
|
20
|
+
- converting requirements into implementation strategy,
|
|
21
|
+
- planning T2/T3 work,
|
|
22
|
+
- scoping refactors or integrations,
|
|
23
|
+
- preparing work for slicing or execution,
|
|
24
|
+
- deepening an existing plan.
|
|
25
|
+
|
|
26
|
+
## When to skip
|
|
27
|
+
|
|
28
|
+
Skip when:
|
|
29
|
+
|
|
30
|
+
- the user only needs orientation (`vc-orient`),
|
|
31
|
+
- the bug lacks root cause (`vc-debug`),
|
|
32
|
+
- the task is trivial and safe to execute directly,
|
|
33
|
+
- product scope is still unresolved (`vc-align`).
|
|
34
|
+
|
|
35
|
+
## Inputs
|
|
36
|
+
|
|
37
|
+
Prefer, in order:
|
|
38
|
+
|
|
39
|
+
1. requirements doc from alignment,
|
|
40
|
+
2. align notes,
|
|
41
|
+
3. `STRATEGY.md`,
|
|
42
|
+
4. `CONTEXT.md` / `CONTEXT-MAP.md`,
|
|
43
|
+
5. relevant ADRs,
|
|
44
|
+
6. issue/PR/user prompt,
|
|
45
|
+
7. codebase research.
|
|
46
|
+
|
|
47
|
+
## Workflow
|
|
48
|
+
|
|
49
|
+
### 1. Classify tier
|
|
50
|
+
|
|
51
|
+
| Tier | Use for | Research |
|
|
52
|
+
|---|---|---|
|
|
53
|
+
| T1 | known, low-risk work | local scan |
|
|
54
|
+
| T2 | moderate ambiguity, unfamiliar module, integration | local + focused research |
|
|
55
|
+
| T3 | architecture, security, privacy, payments, migrations, harness loop | gated deep research |
|
|
56
|
+
|
|
57
|
+
Ask before expensive T3 research when the harness has cost implications.
|
|
58
|
+
|
|
59
|
+
### 2. Gather context
|
|
60
|
+
|
|
61
|
+
Always inspect:
|
|
62
|
+
|
|
63
|
+
- relevant modules and public interfaces,
|
|
64
|
+
- nearby tests,
|
|
65
|
+
- project instructions,
|
|
66
|
+
- domain glossary and ADRs,
|
|
67
|
+
- existing plans/solutions/knowledge docs,
|
|
68
|
+
- similar implementations.
|
|
69
|
+
|
|
70
|
+
Use external research only when local patterns are thin or the topic is high-risk.
|
|
71
|
+
|
|
72
|
+
### 3. Resolve planning-time questions
|
|
73
|
+
|
|
74
|
+
Separate:
|
|
75
|
+
|
|
76
|
+
- planning-time decisions that affect architecture, scope, sequencing, or risk,
|
|
77
|
+
- implementation-time discoveries such as final helper names or exact query shape.
|
|
78
|
+
|
|
79
|
+
Ask the user only for planning-time decisions that cannot be responsibly inferred.
|
|
80
|
+
|
|
81
|
+
### 4. Write implementation units
|
|
82
|
+
|
|
83
|
+
Use stable unit IDs:
|
|
84
|
+
|
|
85
|
+
```markdown
|
|
86
|
+
### U1. Add saved-search creation path
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
For each feature-bearing unit include:
|
|
90
|
+
|
|
91
|
+
- **Goal**
|
|
92
|
+
- **Requirements**
|
|
93
|
+
- **Dependencies**
|
|
94
|
+
- **Files** — repo-relative paths only
|
|
95
|
+
- **Approach** — decisions and boundaries, not code
|
|
96
|
+
- **Execution note** — optional test-first/characterization-first/migration-safe signal
|
|
97
|
+
- **Patterns to follow**
|
|
98
|
+
- **Test scenarios** — happy, edge, error, integration as applicable
|
|
99
|
+
- **Verification** — outcome-based completion signal
|
|
100
|
+
|
|
101
|
+
Do not turn units into micro-steps or code instructions.
|
|
102
|
+
|
|
103
|
+
### 5. Check vertical-slice readiness
|
|
104
|
+
|
|
105
|
+
Mark whether units are:
|
|
106
|
+
|
|
107
|
+
- independently shippable vertical slices,
|
|
108
|
+
- supporting preparatory units,
|
|
109
|
+
- HITL decision units,
|
|
110
|
+
- risk-reduction prototypes.
|
|
111
|
+
|
|
112
|
+
This prepares `vc-slice` to create good issues.
|
|
113
|
+
|
|
114
|
+
### 6. Review before writing
|
|
115
|
+
|
|
116
|
+
Verify:
|
|
117
|
+
|
|
118
|
+
- no invented product behavior,
|
|
119
|
+
- domain terms match `CONTEXT.md`,
|
|
120
|
+
- ADR conflicts are surfaced,
|
|
121
|
+
- file paths are repo-relative,
|
|
122
|
+
- feature units have test scenarios,
|
|
123
|
+
- high-risk areas include rollout or operational notes,
|
|
124
|
+
- deferred work is separate from active scope,
|
|
125
|
+
- no implementation code or shell choreography is embedded.
|
|
126
|
+
|
|
127
|
+
### 7. Save the plan
|
|
128
|
+
|
|
129
|
+
Default:
|
|
130
|
+
|
|
131
|
+
```text
|
|
132
|
+
docs/plans/YYYY-MM-DD-NNN-<type>-<slug>-plan.md
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Use `feat`, `fix`, or `refactor`. If the repo has chosen unified lifecycle docs, use `docs/knowledge/<slug>.md` with appropriate frontmatter.
|
|
136
|
+
|
|
137
|
+
## Output
|
|
138
|
+
|
|
139
|
+
```markdown
|
|
140
|
+
## Plan Ready
|
|
141
|
+
|
|
142
|
+
**File:** ...
|
|
143
|
+
**Tier:** T1 | T2 | T3
|
|
144
|
+
**Source artifacts:** ...
|
|
145
|
+
**Implementation units:** ...
|
|
146
|
+
**High-risk areas:** ...
|
|
147
|
+
**Recommended next skill:** vc-review | vc-slice | vc-execute
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Guardrails
|
|
151
|
+
|
|
152
|
+
- Do not code during planning.
|
|
153
|
+
- Do not over-research low-risk work.
|
|
154
|
+
- Do not publish issues automatically.
|
|
155
|
+
- Do not create horizontal units like “backend”, “frontend”, and “tests” unless independently valuable.
|
|
156
|
+
- Do not hide uncertainty as fake certainty.
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vc-prototype
|
|
3
|
+
description: Build a throwaway prototype to answer one design question before committing to production architecture. Use when exploring uncertain state machines, data models, UI variations, interaction flows, interface shapes, performance feasibility, or harness/tool UX experiments.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Vector Cadence Prototype
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Answer one design question with the smallest safe throwaway artifact. The value is the decision, not the prototype code.
|
|
11
|
+
|
|
12
|
+
## Operating model
|
|
13
|
+
|
|
14
|
+
Name the question, build only enough to answer it, evaluate with the user, then delete, mark, or convert the result into a plan/ADR/issue.
|
|
15
|
+
|
|
16
|
+
## When to use
|
|
17
|
+
|
|
18
|
+
Use when asking:
|
|
19
|
+
|
|
20
|
+
- does this state model feel right?
|
|
21
|
+
- which UI shape is better?
|
|
22
|
+
- can this tool workflow work?
|
|
23
|
+
- what is the smallest useful version?
|
|
24
|
+
- should this be a module, command, prompt workflow, or extension?
|
|
25
|
+
|
|
26
|
+
## When to skip
|
|
27
|
+
|
|
28
|
+
Skip when:
|
|
29
|
+
|
|
30
|
+
- the path is already clear,
|
|
31
|
+
- normal TDD implementation is cheaper,
|
|
32
|
+
- the prototype would touch real auth, billing, external effects, or production data without isolation.
|
|
33
|
+
|
|
34
|
+
## Prototype routes
|
|
35
|
+
|
|
36
|
+
| Question | Prototype shape |
|
|
37
|
+
|---|---|
|
|
38
|
+
| state/business logic | tiny terminal or script harness |
|
|
39
|
+
| UI/UX | switchable variations on one route/page |
|
|
40
|
+
| API/interface | fake caller exercising proposed shapes |
|
|
41
|
+
| agent/harness workflow | mocked tool loop with recorded inputs/outputs |
|
|
42
|
+
| performance | measurement spike with explicit benchmark |
|
|
43
|
+
|
|
44
|
+
## Workflow
|
|
45
|
+
|
|
46
|
+
### 1. Name the question
|
|
47
|
+
|
|
48
|
+
Write one sentence:
|
|
49
|
+
|
|
50
|
+
> This prototype answers: “...”
|
|
51
|
+
|
|
52
|
+
If there are multiple questions, split them or choose the highest-risk one.
|
|
53
|
+
|
|
54
|
+
### 2. Define disposal policy
|
|
55
|
+
|
|
56
|
+
Decide before building:
|
|
57
|
+
|
|
58
|
+
- delete after answer,
|
|
59
|
+
- keep under a clearly marked prototype/temp path,
|
|
60
|
+
- extract selected parts later,
|
|
61
|
+
- capture decision only in plan/ADR.
|
|
62
|
+
|
|
63
|
+
Default: throw away.
|
|
64
|
+
|
|
65
|
+
### 3. Build the smallest artifact
|
|
66
|
+
|
|
67
|
+
Rules:
|
|
68
|
+
|
|
69
|
+
- one command or page to run/view,
|
|
70
|
+
- obvious fake data,
|
|
71
|
+
- clearly marked prototype code,
|
|
72
|
+
- no broad refactors,
|
|
73
|
+
- no hidden production coupling,
|
|
74
|
+
- no real persistence/external effects unless isolated and necessary.
|
|
75
|
+
|
|
76
|
+
### 4. Evaluate
|
|
77
|
+
|
|
78
|
+
Record what worked, what failed, chosen option, changed assumptions, and whether production implementation should proceed.
|
|
79
|
+
|
|
80
|
+
### 5. Cleanup or capture
|
|
81
|
+
|
|
82
|
+
Delete the artifact, retain it intentionally under a marked path, or convert the decision into a plan, issue, or ADR.
|
|
83
|
+
|
|
84
|
+
## Output
|
|
85
|
+
|
|
86
|
+
```markdown
|
|
87
|
+
## Prototype Result
|
|
88
|
+
|
|
89
|
+
**Question:** ...
|
|
90
|
+
**Artifact:** ...
|
|
91
|
+
**How to run/view:** ...
|
|
92
|
+
**Findings:** ...
|
|
93
|
+
**Decision:** ...
|
|
94
|
+
**Cleanup status:** deleted | retained intentionally | needs cleanup
|
|
95
|
+
**Recommended next skill:** vc-align | vc-plan | vc-slice | vc-execute
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Guardrails
|
|
99
|
+
|
|
100
|
+
- Do not prototype five questions at once.
|
|
101
|
+
- Do not treat prototype code as production-ready.
|
|
102
|
+
- Do not leave prototype artifacts unmarked.
|
|
103
|
+
- Do not skip decision capture.
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vc-review
|
|
3
|
+
description: Review code, plans, requirements, or PRs with Standards-vs-Spec framing, persona selection, severity, confidence gates, and actionable routing. Use when reviewing before merge, after implementation, validating a plan/document, or checking security, correctness, performance, or requirements coverage.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Vector Cadence Review
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Check whether work is correct, complete, and safe. Review can apply to code diffs, PRs, plans, and requirements documents.
|
|
11
|
+
|
|
12
|
+
## Operating model
|
|
13
|
+
|
|
14
|
+
Review along two axes: **Standards** (repo conventions and quality bar) and **Spec** (source plan, issue, requirements, or user intent). Use persona-style review and confidence gates when the harness supports subagents.
|
|
15
|
+
|
|
16
|
+
## When to use
|
|
17
|
+
|
|
18
|
+
Use for:
|
|
19
|
+
|
|
20
|
+
- pre-merge code review,
|
|
21
|
+
- T2/T3 implementation gates,
|
|
22
|
+
- plan or requirements review,
|
|
23
|
+
- security/privacy/payments/API/migration changes,
|
|
24
|
+
- resolving whether work satisfies a source artifact.
|
|
25
|
+
|
|
26
|
+
## When to skip
|
|
27
|
+
|
|
28
|
+
Skip or keep lightweight for:
|
|
29
|
+
|
|
30
|
+
- trivial changes with obvious validation,
|
|
31
|
+
- work still being actively implemented,
|
|
32
|
+
- bugs that need root-cause diagnosis first.
|
|
33
|
+
|
|
34
|
+
## Inputs
|
|
35
|
+
|
|
36
|
+
Use:
|
|
37
|
+
|
|
38
|
+
- diff/branch/PR,
|
|
39
|
+
- plan/requirements/issue/agent brief,
|
|
40
|
+
- `AGENTS.md`, `CONTEXT.md`, ADRs,
|
|
41
|
+
- tests and validation results,
|
|
42
|
+
- prior review comments if available.
|
|
43
|
+
|
|
44
|
+
## Workflow
|
|
45
|
+
|
|
46
|
+
### 1. Determine scope
|
|
47
|
+
|
|
48
|
+
Identify changed files, base ref, PR metadata, source artifacts, untracked files, and generated/lockfile exclusions.
|
|
49
|
+
|
|
50
|
+
### 2. Discover intent
|
|
51
|
+
|
|
52
|
+
Read the source artifact when available:
|
|
53
|
+
|
|
54
|
+
- issue agent brief,
|
|
55
|
+
- plan U-IDs and verification criteria,
|
|
56
|
+
- requirements doc,
|
|
57
|
+
- align notes,
|
|
58
|
+
- strategy/domain/ADR constraints.
|
|
59
|
+
|
|
60
|
+
If no meaningful spec exists, review Standards only and label Spec uncertainty.
|
|
61
|
+
|
|
62
|
+
### 3. Select review lenses
|
|
63
|
+
|
|
64
|
+
Always consider:
|
|
65
|
+
|
|
66
|
+
- correctness,
|
|
67
|
+
- testing,
|
|
68
|
+
- maintainability,
|
|
69
|
+
- project standards,
|
|
70
|
+
- requirements coverage.
|
|
71
|
+
|
|
72
|
+
Add conditionals:
|
|
73
|
+
|
|
74
|
+
- security for auth, permissions, public endpoints, user input,
|
|
75
|
+
- performance for queries, caching, async, transformations,
|
|
76
|
+
- API contract for routes, types, serializers, public interfaces,
|
|
77
|
+
- data migration for migrations/backfills/schema,
|
|
78
|
+
- reliability for retries, timeouts, jobs, error handling,
|
|
79
|
+
- adversarial for large or high-risk diffs,
|
|
80
|
+
- agent-native for harness/tool/agent features.
|
|
81
|
+
|
|
82
|
+
### 4. Dispatch reviewers if available
|
|
83
|
+
|
|
84
|
+
If the harness provides subagents, reviewer subagents must be read-only. They may inspect files and run non-mutating commands, but must not edit, commit, push, or change branches.
|
|
85
|
+
|
|
86
|
+
Use bounded parallelism and treat capacity errors as backpressure.
|
|
87
|
+
|
|
88
|
+
### 5. Merge findings
|
|
89
|
+
|
|
90
|
+
For each finding record:
|
|
91
|
+
|
|
92
|
+
- title,
|
|
93
|
+
- severity P0-P3,
|
|
94
|
+
- file/line,
|
|
95
|
+
- confidence 0/25/50/75/100,
|
|
96
|
+
- evidence,
|
|
97
|
+
- reviewer/lens,
|
|
98
|
+
- route.
|
|
99
|
+
|
|
100
|
+
Suppress low-confidence findings below 75 unless P0 risk warrants attention. Separate pre-existing issues.
|
|
101
|
+
|
|
102
|
+
### 6. Route actions
|
|
103
|
+
|
|
104
|
+
| Route | Meaning |
|
|
105
|
+
|---|---|
|
|
106
|
+
| safe_auto | local deterministic fix may be applied if policy allows |
|
|
107
|
+
| gated_auto | concrete fix exists but changes behavior/contracts; ask or hand off |
|
|
108
|
+
| manual | actionable but needs human/downstream resolver |
|
|
109
|
+
| advisory | FYI, rollout, risk, or learning |
|
|
110
|
+
|
|
111
|
+
Do not auto-fix behavior-changing findings without a gate.
|
|
112
|
+
|
|
113
|
+
### 7. Present verdict
|
|
114
|
+
|
|
115
|
+
Use tables for findings. Include:
|
|
116
|
+
|
|
117
|
+
- scope,
|
|
118
|
+
- intent source,
|
|
119
|
+
- Standards findings,
|
|
120
|
+
- Spec findings,
|
|
121
|
+
- requirements completeness,
|
|
122
|
+
- testing gaps,
|
|
123
|
+
- residual risks,
|
|
124
|
+
- pre-existing issues,
|
|
125
|
+
- verdict.
|
|
126
|
+
|
|
127
|
+
Verdict options:
|
|
128
|
+
|
|
129
|
+
- Ready to merge,
|
|
130
|
+
- Ready with fixes,
|
|
131
|
+
- Not ready.
|
|
132
|
+
|
|
133
|
+
A code-clean PR that misses explicit requirements is not ready unless the omission is intentional.
|
|
134
|
+
|
|
135
|
+
## Output
|
|
136
|
+
|
|
137
|
+
```markdown
|
|
138
|
+
## Review Summary
|
|
139
|
+
|
|
140
|
+
**Scope:** ...
|
|
141
|
+
**Intent source:** ...
|
|
142
|
+
**Verdict:** Ready | Ready with fixes | Not ready
|
|
143
|
+
**Must fix:** ...
|
|
144
|
+
**Should fix:** ...
|
|
145
|
+
**Testing gaps:** ...
|
|
146
|
+
**Residual risks:** ...
|
|
147
|
+
**Recommended next skill:** vc-execute | vc-debug | vc-learn
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Guardrails
|
|
151
|
+
|
|
152
|
+
- Do not let reviewer subagents mutate project files.
|
|
153
|
+
- Do not flood reports with low-confidence taste opinions.
|
|
154
|
+
- Do not review against imagined requirements when source artifacts exist.
|
|
155
|
+
- Do not silently drop explicit requirements from the verdict.
|
|
156
|
+
- Do not block on inferred requirements alone.
|