@nurix/etna 0.18.10 → 0.18.12
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 +13 -13
- package/bin/etna.js +98 -2
- package/data/harness-index.json +9 -1
- package/data/harnesses/code/CLAUDE.md +9 -10
- package/data/harnesses/code/agents/brainstorm.md +3 -3
- package/data/harnesses/code/agents/change-review.md +4 -4
- package/data/harnesses/code/agents/maintenance.md +177 -59
- package/data/harnesses/code/agents/spec-mode.md +3 -3
- package/data/harnesses/code/harness.json +2 -2
- package/data/harnesses/code/hooks/generate-ownership-index.mjs +148 -0
- package/data/harnesses/code/hooks/hooks.json +12 -0
- package/data/harnesses/code/skills/boundary/references/boundary-taxonomy.md +3 -3
- package/data/harnesses/code/skills/brainstorm/README.md +11 -9
- package/data/harnesses/code/skills/brainstorm/SKILL.md +2 -2
- package/data/harnesses/code/skills/brainstorm/harvest.md +5 -6
- package/data/harnesses/code/skills/distiller/SKILL.md +3 -3
- package/data/harnesses/code/skills/distiller/references/docs-mode.md +7 -7
- package/data/harnesses/code/skills/documentation/SKILL.md +23 -23
- package/data/harnesses/code/skills/documentation/references/templates.md +26 -64
- package/data/harnesses/etna/.prettierignore +12 -0
- package/data/harnesses/etna/.prettierrc.json +3 -0
- package/data/harnesses/etna/.vscode/settings.json +10 -0
- package/data/harnesses/etna/CLAUDE.md +151 -0
- package/data/harnesses/etna/agents/brainstorm.md +35 -0
- package/data/harnesses/etna/agents/change-review.md +251 -0
- package/data/harnesses/etna/agents/maintenance.md +240 -0
- package/data/harnesses/etna/agents/performance-review.md +223 -0
- package/data/harnesses/etna/agents/spec-mode.md +56 -0
- package/data/harnesses/etna/harness.json +11 -0
- package/data/harnesses/etna/hooks/generate-ownership-index.mjs +148 -0
- package/data/harnesses/etna/hooks/hooks.json +39 -0
- package/data/harnesses/etna/hooks/lib/redact.mjs +35 -0
- package/data/harnesses/etna/hooks/prompt-recall.mjs +155 -0
- package/data/harnesses/etna/hooks/session-reflect.mjs +285 -0
- package/data/harnesses/etna/rules/general.md +86 -0
- package/data/harnesses/etna/rules/kb.md +13 -0
- package/data/harnesses/etna/rules/nomenclature.md +41 -0
- package/data/harnesses/etna/rules/npm-cli.md +88 -0
- package/data/harnesses/etna/skills/boundary/SKILL.md +49 -0
- package/data/harnesses/etna/skills/boundary/references/boundary-taxonomy.md +796 -0
- package/data/harnesses/etna/skills/brainstorm/README.md +138 -0
- package/data/harnesses/etna/skills/brainstorm/SKILL.md +135 -0
- package/data/harnesses/etna/skills/brainstorm/harvest.md +25 -0
- package/data/harnesses/etna/skills/brainstorm/templates/backlog.md +39 -0
- package/data/harnesses/etna/skills/brainstorm/templates/build.md +37 -0
- package/data/harnesses/etna/skills/brainstorm/templates/decisions.md +29 -0
- package/data/harnesses/etna/skills/brainstorm/templates/doctrine.md +31 -0
- package/data/harnesses/etna/skills/brainstorm/templates/domain-model.md +25 -0
- package/data/harnesses/etna/skills/brainstorm/templates/glossary.md +20 -0
- package/data/harnesses/etna/skills/brainstorm/templates/milestones.md +43 -0
- package/data/harnesses/etna/skills/brainstorm/templates/non-goals.md +17 -0
- package/data/harnesses/etna/skills/brainstorm/templates/plan-doc.md +61 -0
- package/data/harnesses/etna/skills/brainstorm/templates/questions.md +36 -0
- package/data/harnesses/etna/skills/brainstorm/templates/references.md +28 -0
- package/data/harnesses/etna/skills/brainstorm/templates/rejected.md +29 -0
- package/data/harnesses/etna/skills/brainstorm/templates/state.md +1 -0
- package/data/harnesses/etna/skills/brainstorm/templates/tech.md +23 -0
- package/data/harnesses/etna/skills/brainstorm/templates/thesis.md +21 -0
- package/data/harnesses/etna/skills/distiller/SKILL.md +90 -0
- package/data/harnesses/etna/skills/distiller/references/docs-mode.md +299 -0
- package/data/harnesses/etna/skills/distiller/references/method.md +94 -0
- package/data/harnesses/etna/skills/documentation/SKILL.md +124 -0
- package/data/harnesses/etna/skills/documentation/references/examples.md +162 -0
- package/data/harnesses/etna/skills/documentation/references/style-guide.md +308 -0
- package/data/harnesses/etna/skills/documentation/references/templates.md +853 -0
- package/data/harnesses/etna/skills/workflow-mapper/SKILL.md +451 -0
- package/data/harnesses/etna/skills/workflow-mapper/references/patterns.md +214 -0
- package/data/harnesses/hr/harness.json +1 -1
- package/data/harnesses/hr/skills/evaluator/criteria/testing.md +4 -4
- package/data/harnesses/mobile/.prettierignore +12 -0
- package/data/harnesses/mobile/.prettierrc.json +3 -0
- package/data/harnesses/mobile/.vscode/settings.json +10 -0
- package/data/harnesses/mobile/CLAUDE.md +128 -0
- package/data/harnesses/mobile/agents/brainstorm.md +35 -0
- package/data/harnesses/mobile/agents/change-review.md +251 -0
- package/data/harnesses/mobile/agents/maintenance.md +240 -0
- package/data/harnesses/mobile/agents/performance-review.md +223 -0
- package/data/harnesses/mobile/agents/spec-mode.md +56 -0
- package/data/harnesses/mobile/harness.json +11 -0
- package/data/harnesses/mobile/hooks/generate-ownership-index.mjs +148 -0
- package/data/harnesses/mobile/hooks/hooks.json +39 -0
- package/data/harnesses/mobile/hooks/lib/redact.mjs +35 -0
- package/data/harnesses/mobile/hooks/prompt-recall.mjs +155 -0
- package/data/harnesses/mobile/hooks/session-reflect.mjs +285 -0
- package/data/harnesses/mobile/rules/general.md +86 -0
- package/data/harnesses/mobile/rules/nomenclature.md +41 -0
- package/data/harnesses/mobile/rules/react-native.md +132 -0
- package/data/harnesses/mobile/rules/typescript.md +40 -0
- package/data/harnesses/mobile/skills/boundary/SKILL.md +49 -0
- package/data/harnesses/mobile/skills/boundary/references/boundary-taxonomy.md +796 -0
- package/data/harnesses/mobile/skills/brainstorm/README.md +138 -0
- package/data/harnesses/mobile/skills/brainstorm/SKILL.md +135 -0
- package/data/harnesses/mobile/skills/brainstorm/harvest.md +25 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/backlog.md +39 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/build.md +37 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/decisions.md +29 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/doctrine.md +31 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/domain-model.md +25 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/glossary.md +20 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/milestones.md +43 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/non-goals.md +17 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/plan-doc.md +61 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/questions.md +36 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/references.md +28 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/rejected.md +29 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/state.md +1 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/tech.md +23 -0
- package/data/harnesses/mobile/skills/brainstorm/templates/thesis.md +21 -0
- package/data/harnesses/mobile/skills/distiller/SKILL.md +90 -0
- package/data/harnesses/mobile/skills/distiller/references/docs-mode.md +299 -0
- package/data/harnesses/mobile/skills/distiller/references/method.md +94 -0
- package/data/harnesses/mobile/skills/documentation/SKILL.md +124 -0
- package/data/harnesses/mobile/skills/documentation/references/examples.md +162 -0
- package/data/harnesses/mobile/skills/documentation/references/style-guide.md +308 -0
- package/data/harnesses/mobile/skills/documentation/references/templates.md +853 -0
- package/data/harnesses/mobile/skills/workflow-mapper/SKILL.md +451 -0
- package/data/harnesses/mobile/skills/workflow-mapper/references/patterns.md +214 -0
- package/package.json +1 -1
- package/data/harnesses/code/agents/harness-manager.md +0 -184
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# Agent Instructions
|
|
2
|
+
|
|
3
|
+
This file defines how AI agents (Claude, GPT, etc.) should work on this project.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
- Read **[`docs/structure.md`](docs/structure.md)** for the documentation map and folder authority (architecture, features, operations)
|
|
10
|
+
- Read **[`docs/memory/`](docs/memory/)** for agent memory files (one per agent)
|
|
11
|
+
- Ignore **[`README.md`](README.md)** – it's for human reference only
|
|
12
|
+
- Check **[`package.json`](package.json)** for available scripts. Detect the package manager from the lockfile (`pnpm-lock.yaml` → pnpm, `yarn.lock` → yarn, `package-lock.json` → npm) and use the matching command. Don't hardcode a specific manager.
|
|
13
|
+
- Look at similar modules/files and follow existing patterns
|
|
14
|
+
|
|
15
|
+
> **If you are a Claude agent** (for example, `claude-4.5-sonnet`) — other agents ignore: Check **[`.claude/rules/`](.claude/rules/)** for specialized instructions (automatically loaded into memory) Skip the next step — `.github/instructions/` contains the same files as `.claude/rules/`
|
|
16
|
+
|
|
17
|
+
- Review **[`.github/instructions/`](.github/instructions/)** for coding conventions (Claude agents: see note above)
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Workflows
|
|
22
|
+
|
|
23
|
+
For new features or new systems, enter **Spec Mode** before Plan Mode.
|
|
24
|
+
|
|
25
|
+
### Spec Mode → Plan Mode → Completion
|
|
26
|
+
|
|
27
|
+
1. **Spec Mode**: Create or update a feature spec in `docs/features/{feature}.md` using the **Feature Documentation template** (Status: Draft) — see `.claude/skills/documentation/references/templates.md` §6. Use the **`spec-mode`** agent (`.claude/agents/spec-mode.md`) for codebase research; its findings drop directly into the template's research-derived sections (Affected Modules, Conventions to Follow, Current Behavior, Ownership Conflicts). Interview the user for the design-intent sections (Goal, Goals & Non-Goals, Background, Approach). Present the spec for approval before proceeding.
|
|
28
|
+
|
|
29
|
+
2. **Plan Mode**: Once the spec is approved, create a plan in `docs/history/plans/YYYY-MM-DD-feature-name.md` using the **Plan template** (see `.claude/skills/documentation/references/templates.md` §8). Link back to the feature spec in the **Spec** field. The template's **Proposed Changes** sections are load-bearing — the `boundary` skill parses them to check boundary impact.
|
|
30
|
+
|
|
31
|
+
3. **Completion**: When a plan is fully implemented:
|
|
32
|
+
- Mark the plan `Status: Complete` in `docs/history/plans/` and fill the **Completed:** date. The plan is now frozen.
|
|
33
|
+
- **Flip the feature spec** to `status: active` and extend it in place with the implementation sections (Architecture, Key Functions, State, Redux, Files). No template swap — the same file gains sections describing how the feature _works_ alongside the design-intent sections that explain _why_. Confirm the feature's `owns:` globs against actual code; resolve any unresolved Open Questions by folding them into Background.
|
|
34
|
+
- Use the injected ownership index to find other docs affected by the changes (and update the `owns:` globs of any feature doc whose source you moved or added). Update affected docs — or create new ones if a touched area has no doc yet.
|
|
35
|
+
|
|
36
|
+
For **Product-level** work (new systems, unclear scope), the spec should also include: problem statement, key hypotheses, and open questions.
|
|
37
|
+
|
|
38
|
+
`docs/features/` is _what_ we're building (lives on as documentation). `docs/history/plans/` is _how_ we built it (historical record).
|
|
39
|
+
|
|
40
|
+
### Context Routing
|
|
41
|
+
|
|
42
|
+
Before modifying code in an unfamiliar area:
|
|
43
|
+
|
|
44
|
+
1. Consult the **injected ownership index** — the generated `glob → doc · module · keywords · status` map, surfaced into context at session start (the union of every feature doc's `owns:` frontmatter). Match your path or topic (its `keywords:`) to the owning doc and read it before changes. (If no ownership index appears in context, the repo isn't reconciled — run `maintenance` in baseline mode to reconcile it.)
|
|
45
|
+
2. If `qmd` is installed, run `qmd query --format json -c <collection> "<topic>"` for semantic recall over the indexed docs — prefer it when entering an unfamiliar area; absent ⇒ skip.
|
|
46
|
+
3. If your change touches a cross-cutting contract area (entity model, db schema, wire envelope, auth/authz, event vocabulary, webhooks, env/config), run the **`boundary`** skill scoped to your change — it reads both sides of each touched contract in source and reports what would break.
|
|
47
|
+
4. If a `docs/memory/` file exists for the domain you're working in, read it for domain knowledge and failure modes
|
|
48
|
+
|
|
49
|
+
For the protocol on _writing_ to memory (which file, what belongs there, what doesn't), see **Project Memory** below.
|
|
50
|
+
|
|
51
|
+
### Project Memory
|
|
52
|
+
|
|
53
|
+
Project-specific learnings live in `docs/memory/` (git-tracked). Cross-project user preferences live in `~/.claude/` (untracked).
|
|
54
|
+
|
|
55
|
+
| File | Owner | Contents |
|
|
56
|
+
| --- | --- | --- |
|
|
57
|
+
| `docs/memory/main.md` | Main agent | Project-wide patterns, conventions confirmed in this codebase, recurring failure modes, decisions whose rationale isn't obvious from the code |
|
|
58
|
+
| `docs/memory/{agent-name}.md` | The named sub-agent | Strategy memory for that agent — how to be more effective on this project (research patterns, taxonomy, ownership conflict zones). Never user-centric. |
|
|
59
|
+
| `~/.claude/projects/...` | Auto-memory system | User preferences, role, communication style, cross-project habits |
|
|
60
|
+
|
|
61
|
+
**Override the default auto-memory location for project-relevant facts.** When recording a learning, ask: _is this true of this project, or true of this user?_ Project facts → `docs/memory/`. User facts → `~/.claude/`.
|
|
62
|
+
|
|
63
|
+
`docs/memory/main.md` is created on first write. Append entries dated `## YYYY-MM-DD — {topic}`; oldest at bottom is fine.
|
|
64
|
+
|
|
65
|
+
### Out-of-Scope Discovery
|
|
66
|
+
|
|
67
|
+
When implementing a plan, if you discover work that is important but outside the current plan's scope:
|
|
68
|
+
|
|
69
|
+
- Append it to `docs/history/backlog.md` under the appropriate priority (P0-P3)
|
|
70
|
+
- Format: `- **[P1]** Description — discovered by [plan-name or agent-name]`
|
|
71
|
+
- Do NOT ask permission. Just append and mention it in your response.
|
|
72
|
+
|
|
73
|
+
### Doc Ownership
|
|
74
|
+
|
|
75
|
+
Which doc is canonical for which code paths is the **feature doc's own frontmatter**. A feature doc (flat in `docs/features/`) carries `owns:` (code-path globs — the only ownership key), `module:` (a bounded-context label, omitted when cross-cutting), `keywords:` (discovery), and `status:`. Code → doc ownership is the union of every feature doc's `owns:` globs, surfaced as the generated ownership index at session start. Architecture docs describe cross-cutting patterns and don't own specific files; operations docs describe procedures. A living doc may additionally carry an optional `anchors:` block (a qmd drift tripwire, not ownership).
|
|
76
|
+
|
|
77
|
+
The spec-mode agent checks for ownership conflicts during research — feature docs whose `owns:` globs overlap at equal specificity. If conflicts are found, address them in the spec before proceeding.
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Boundaries
|
|
82
|
+
|
|
83
|
+
A boundary is a horizontal cross-cutting contract — entity model, db schema, wire envelope, auth/authz, event vocabulary, webhooks, env/config — where editing one side silently breaks the other. Boundaries are **diagnosed, not documented**: the `boundary` skill reads them fresh from source whenever a check runs, so they are never persisted as docs and can never go stale.
|
|
84
|
+
|
|
85
|
+
**Invoke the `boundary` skill after a plan is approved and before its first implementation step.** It parses the plan's Proposed Changes, reads the touched source files, identifies the contracts they participate in (its `references/boundary-taxonomy.md` is the catalog), traces the consumers on the other side, and reports severity-ranked violations with suggested plan amendments — in chat, read-only. Fold the amendments into the plan before coding. For non-plan edits in contract-heavy code, run the same diagnostic scoped to the diff.
|
|
86
|
+
|
|
87
|
+
> Agents and skills live under `.claude/agents/` and `.claude/skills/`. Their triggers are model-invoked — refer to each component's frontmatter, not a registry table here.
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Boundaries & Defaults
|
|
92
|
+
|
|
93
|
+
Unless explicitly requested:
|
|
94
|
+
|
|
95
|
+
❌ **Tests** – Never generate, update, or modify test files. ❌ **Dependencies** – Never upgrade frameworks, libraries, or dependencies. ❌ **Compatibility** – Never maintain backward compatibility unless specified. ❌ **Browser Automation** – Never use "Claude in Chrome" (CDP/MCP browser tools) unless the user explicitly requests it. ❌ **Protected Files** – Never modify these read-only files: `AGENTS.md`, `.github/instructions/`, `.github/prompts/`, `docs/operations/protected-files.md` ✅ **Documentation** – Keep `docs/` updated when code changes affect documented behavior. ⚠️ **Plans** – Plans are created directly in `docs/history/plans/` (see Workflow → Plan Mode). Once `Status: Complete` or `Status: Abandoned`, the file is frozen — never edited. If scope changes after completion, write a new dated plan that links back to the old one. ⚠️ **Tool Issues** – If any CLI tool, shell alias, or MCP tool behaves unexpectedly (syntax errors, silent failures, wrong defaults), report the exact tool name, command, and error to the user so they can fix or remove the underlying library.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## File Structure
|
|
100
|
+
|
|
101
|
+
- Add file path at top of each file: `// src/modules/example.js - Module for handling user authentication`
|
|
102
|
+
- Add a 1-line function description as a comment above each function: `// Extract JWT token from request based on endpoint type`
|
|
103
|
+
- Keep related code together in a logical hierarchy.
|
|
104
|
+
- No inline comments that restate obvious code. No commented-out code. If a block of code needs a comment to be understandable, refactor for clarity instead.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## Documentation
|
|
109
|
+
|
|
110
|
+
- **[`docs/structure.md`](docs/structure.md)** – Documentation authority map (start here for all docs)
|
|
111
|
+
- Only `CLAUDE.md`, `AGENTS.md`, and `README.md` are allowed in the repository root
|
|
112
|
+
- One canonical source per topic — link, don't copy
|
|
113
|
+
|
|
114
|
+
### Folder Structure
|
|
115
|
+
|
|
116
|
+
The six procedural folders below are fixed. Domain folders (e.g. `core/`) live as subfolders inside these — `docs/architecture/core/` for core module internals, `docs/features/{group}/` as browse-only groupings (never modules). Discovery flows through the generated **ownership index** (from feature `owns:`/`keywords:` frontmatter), injected at session start.
|
|
117
|
+
|
|
118
|
+
| Folder | Purpose | Mutability |
|
|
119
|
+
| --- | --- | --- |
|
|
120
|
+
| `docs/architecture/` | System-wide patterns, technical decisions, API specs | Living |
|
|
121
|
+
| `docs/features/` | How implemented features work today | Living |
|
|
122
|
+
| `docs/operations/` | Setup, development, deployment | Living |
|
|
123
|
+
| `docs/history/` | Plans, changelogs, backlog | Frozen or append-only |
|
|
124
|
+
| `docs/memory/` | Project knowledge + agent state | Living |
|
|
125
|
+
| `docs/tests/` | Test plans and automation | Living |
|
|
126
|
+
|
|
127
|
+
### Naming & Lifecycle
|
|
128
|
+
|
|
129
|
+
- Features: `kebab-case.md` — living reference, status `Active`
|
|
130
|
+
- Plans: `YYYY-MM-DD-kebab-case.md` — frozen after `Complete` or `Abandoned`
|
|
131
|
+
- Changelogs: `YYYY-MM-DD-kebab-case.md` — append-only
|
|
132
|
+
- Memory: `{agent-name}.md` — agent-maintained
|
|
133
|
+
|
|
134
|
+
### Documentation Maintenance
|
|
135
|
+
|
|
136
|
+
- **Prerequisite**: Before creating changelogs, feature docs, or plans, check that `docs/memory/index.md` exists and records a baseline. If not, prompt the user to baseline docs first.
|
|
137
|
+
- After plan completion: create a `docs/history/changelog/YYYY-MM-DD-feature-name.md` entry + update the index in `docs/history/CHANGELOG.md` (no confirmation needed). Root-level `CHANGELOG.md` is not used — only `CLAUDE.md`, `AGENTS.md`, and `README.md` live in the repo root.
|
|
138
|
+
- Update related docs affected by the changes (use the injected ownership index — feature `owns:` globs — to find the right files)
|
|
139
|
+
- Non-plan changes (refactors, bug fixes, API changes): prompt user first
|
|
140
|
+
- Multi-commit changes: include `Commits: abc1234, def5678`
|
|
141
|
+
|
|
142
|
+
### Keeping the Loop Tight
|
|
143
|
+
|
|
144
|
+
When you create a new doc that owns code:
|
|
145
|
+
|
|
146
|
+
- Declare the code paths it owns in its own `owns:` frontmatter (plus `module:`/`keywords:`/`status:`); the generated ownership index picks it up at the next session start.
|
|
147
|
+
- Verify its `owns:` globs don't overlap another feature doc's at equal specificity.
|
|
148
|
+
|
|
149
|
+
When you move or rename source files:
|
|
150
|
+
|
|
151
|
+
- Update the `owns:` globs of the feature doc that owns them to the new paths.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: brainstorm
|
|
3
|
+
description: Brainstorming-mode facilitator — a thin orchestrator over the self-contained `brainstorm` skill, which owns every session mechanic (the constant distill→abstract→sync→record loop, the four modes, the basis entry gate, the background sync reconciler, the complexity-scaled pillar surface, harvest). Use to recognize when a conversation belongs at the 30k-foot strategic-design altitude and drive it in the skill's voice. Triggers on an explicit ask to brainstorm/design strategically, or on recognizing that a user utterance challenges a loaded pillar headline — which you OFFER a session for (suggest `/brainstorm start`), never silently enter.
|
|
4
|
+
tools: Read, Glob, Grep, AskUserQuestion, Write
|
|
5
|
+
model: inherit
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Brainstorm Agent
|
|
9
|
+
|
|
10
|
+
You are the **facilitator persona** for Brainstorming Mode — the 30,000-foot peer of Spec and Plan. You shape the **pillars** that steer the repo through conversation, never by writing production code or feature specs. The pillar surface scales with the idea's complexity — see the skill's **Pillars** table rather than carrying a fixed list in your head.
|
|
11
|
+
|
|
12
|
+
You are a **thin orchestrator.** Every mechanic — the constant loop, the four modes, the basis entry gate, the background sync reconciler, the complexity-scaled pillars, append-only decisions, and harvest — lives in the **`brainstorm` skill**, which is self-contained and runs standalone via `/brainstorm start|stop`. Your only jobs: recognize when a conversation belongs in Brainstorming Mode, and drive it in the skill's voice. **Defer to the skill's `SKILL.md` for every mechanic — read it rather than re-deriving, and never restate its rules here.**
|
|
13
|
+
|
|
14
|
+
## When to offer a session
|
|
15
|
+
|
|
16
|
+
- An explicit ask to think through a design at a strategic level (not "fix this bug" / "add this button"). This is the user invoking the work; hand it to `/brainstorm start`.
|
|
17
|
+
- A user utterance **challenges a loaded pillar headline.** To recognize this, hold the headlines in mind — skim `docs/architecture/` (`domain-model.md`, `glossary.md`, `non-goals.md`, `open-questions.md`) and its `adr/` decision titles. The steering layer lives there; there are no `docs/modules/` or `docs/pillars/` folders. When a proposal brushes an existing principle, **name that principle in plain English and offer a session** — suggest `/brainstorm start` and ask whether the proposal preserves or revises it. Detection is yours; entry is the user's. **Never auto-enter** — the skill admits only `/brainstorm start` and `/brainstorm stop`.
|
|
18
|
+
|
|
19
|
+
If none of those steering files exist yet (a freshly-baselined repo), a session still runs from the skill's templates, and the basis gate seeds it from a reference doc or a one-shot brain dump.
|
|
20
|
+
|
|
21
|
+
## Modes and the close gate
|
|
22
|
+
|
|
23
|
+
Four modes exist — **dump / interview / probe / converge** — and they change _who drives_ and _how much gets asked_, not the loop, which never stops. The mode lives in the session's `state.md` and switches only on an explicit user word. The close gate is **open questions**, not decision state: questions are the single convergence currency, and the idea is coherent only when zero remain after a fresh sync. See the skill's **Modes** and **Coherence** sections — don't re-derive them here.
|
|
24
|
+
|
|
25
|
+
## How you facilitate
|
|
26
|
+
|
|
27
|
+
- **Speak plain English; codes live in the files.** Name a pillar item by what it _is_, never by a bare code (`Q3`, `D7`); append the code in parentheses only if traceability needs it.
|
|
28
|
+
- **Suggest, never seize.** Mode shifts, abstractions, and probes are one offer each; accept refusal without re-litigating.
|
|
29
|
+
- **Never write production code** while a session is open — load-bearing snippets are illustration only, inside the session folder.
|
|
30
|
+
|
|
31
|
+
You don't perform the harvest yourself, and you don't presume a destination. On close the skill **offers** the harvest, distilling the pillars' conclusions into wherever the harness routes them. The session folder — where it lives, and whether it is kept or transient — is whatever the `brainstorm` skill defines for this harness; the skill's `## stop` section is the canonical harvest map, so don't duplicate it.
|
|
32
|
+
|
|
33
|
+
## What you may write
|
|
34
|
+
|
|
35
|
+
The session folder only (its pillars and `state.md`), wherever the `brainstorm` skill places it for this harness. Never edit the live docs directly — the harvest does that.
|
|
@@ -0,0 +1,251 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: change-review
|
|
3
|
+
description: Velocity + change-risk analysis. First classifies recent commits into a pipe-delimited velocity/severity CSV by dispatching parallel haiku sub-agents (module, feature, impact, severity, churn), then derives a commit heatmap, risk zones (high churn in contract-heavy code), stabilization signals, and team/bus-factor distribution. Self-contained — produces its own CSV, no separate git-history step. Use when planning where to invest in review focus or rules.
|
|
4
|
+
tools: Bash, Read, Write, Glob, Grep, Task
|
|
5
|
+
model: inherit
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Change-Review Agent
|
|
9
|
+
|
|
10
|
+
You analyze code-change velocity over time to find risk zones — where change is accelerating or decelerating, and whether review attention matches the risk. You answer: "where should the tech lead invest review focus or rules next?"
|
|
11
|
+
|
|
12
|
+
You work in two phases:
|
|
13
|
+
|
|
14
|
+
1. **Classify** — turn recent git history into a structured, pipe-delimited CSV (one classified row per commit) by dispatching parallel haiku sub-agents. You do this yourself; there is no separate agent that hands you a CSV.
|
|
15
|
+
2. **Analyze** — read that CSV and derive the velocity heatmap, risk zones, stabilization signals, and team distribution.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
Parse these from the user's prompt. Use defaults if not specified.
|
|
20
|
+
|
|
21
|
+
| Parameter | Default | Examples |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `since` | `3 months ago` | "last 2 weeks", "since Feb 1", "since 2025-01-01" |
|
|
24
|
+
| `until` | `now` | "until Feb 10" |
|
|
25
|
+
| `batch_size` | `8` | "batches of 10" |
|
|
26
|
+
| `output` | `change-review-YYYY-MM-DD.csv` (today's date) | "write to review.csv" |
|
|
27
|
+
| `skip_merges` | `true` | "include merges" |
|
|
28
|
+
| `branch` | current branch | "on main", "on ai-staging" |
|
|
29
|
+
|
|
30
|
+
The heatmap needs rolling 1w / 1m / 3m windows, so default `since` to 3 months even though the classifier processes every commit in range.
|
|
31
|
+
|
|
32
|
+
## Before Starting
|
|
33
|
+
|
|
34
|
+
1. If `./docs/memory/change-review.md` exists, read it for historical velocity snapshots, prior risk-zone flags, known concentration risks, and the project's **Module Taxonomy** / **Feature Taxonomy** (these classification hints used to live in a separate `git-history.md` memory file — they now live here).
|
|
35
|
+
2. If a recent CSV from a prior run already exists at the project root (`change-review-YYYY-MM-DD.csv`), prefer it as input and **skip Phase 1** — don't re-classify commits unless the requested window changed.
|
|
36
|
+
3. Build the ownership map from feature `owns:` frontmatter — consult the injected ownership index (`glob → doc · module · keywords · status`), or glob `docs/features/**/*.md` and read each doc's `owns:` globs — to map churn to owning feature docs (and their `module:` labels).
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
# Phase 1 — Classify commits into a CSV
|
|
41
|
+
|
|
42
|
+
Output is a pipe-delimited CSV with velocity-relevant columns (files changed, insertions, deletions, directories) so Phase 2 can derive heatmaps and risk zones.
|
|
43
|
+
|
|
44
|
+
## Step 1: Collect Commits
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
git log --format="%h|%ad|%an|%s" --date=short --since="{since}" --until="{until}" --no-merges {branch}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
- If `skip_merges` is false, remove `--no-merges`
|
|
51
|
+
- If `branch` is specified, add it after the flags
|
|
52
|
+
- Report the total commit count and author breakdown before proceeding
|
|
53
|
+
|
|
54
|
+
If zero commits found, stop and tell the user.
|
|
55
|
+
|
|
56
|
+
## Step 2: Pre-compute File Paths & Diff Stats
|
|
57
|
+
|
|
58
|
+
For each commit hash, get changed files and line-level diff stats:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# File names
|
|
62
|
+
git diff-tree --no-commit-id --name-only -r {hash}
|
|
63
|
+
|
|
64
|
+
# Insertions and deletions per file
|
|
65
|
+
git diff-tree --no-commit-id --numstat -r {hash}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Run these in a single bash call using a loop for efficiency. From the numstat output, compute per-commit totals:
|
|
69
|
+
|
|
70
|
+
- `files_changed`: number of files in the commit
|
|
71
|
+
- `insertions`: sum of added lines across all files
|
|
72
|
+
- `deletions`: sum of removed lines across all files
|
|
73
|
+
- `directories`: unique top-level directories touched (e.g., `src/components/Button.jsx` → `src/components`)
|
|
74
|
+
|
|
75
|
+
Build a registry of objects:
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
{ hash, date, author, message, files[], files_changed, insertions, deletions, directories[] }
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Step 3: Batch & Dispatch Sub-Agents
|
|
82
|
+
|
|
83
|
+
Split the commit registry into batches of `batch_size` commits each.
|
|
84
|
+
|
|
85
|
+
Spawn **haiku** sub-agents via the Task tool with `subagent_type: "general-purpose"` and `model: "haiku"`. Launch up to 5 batches in parallel.
|
|
86
|
+
|
|
87
|
+
Before building the prompt template, check if `docs/memory/change-review.md` contains **Module Taxonomy** and **Feature Taxonomy** sections. If yes, inject their content into the `{MODULE_TAXONOMY}` and `{FEATURE_TAXONOMY}` placeholders below. If no memory file exists, use these generic fallbacks:
|
|
88
|
+
|
|
89
|
+
**Generic Module Taxonomy fallback:**
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
Classify by the PRIMARY directory of changed files. Use the top-level directory as the module category (e.g., `src/components/` → `frontend/components`, `app/api/` → `backend/api`). For files spanning 3+ categories, use `multi`.
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
**Generic Feature Taxonomy fallback:**
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
Infer the product area from the commit message and file paths. Use descriptive labels like `auth`, `editor`, `deploy`, `ui`, `infra`, `docs`, `dx`, `other`.
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Each sub-agent receives this prompt template (fill in `{COMMITS_JSON}`, `{BATCH_NUMBER}`, `{MODULE_TAXONOMY}`, and `{FEATURE_TAXONOMY}`):
|
|
102
|
+
|
|
103
|
+
````
|
|
104
|
+
You are a commit classifier. Classify each commit below into a pipe-delimited row.
|
|
105
|
+
|
|
106
|
+
## Output Format
|
|
107
|
+
|
|
108
|
+
Return ONLY pipe-delimited rows, one per commit. No headers. No explanation. No markdown fences.
|
|
109
|
+
|
|
110
|
+
Fields: hash|date|author|message|module|feature|impact_type|severity|breaking|files_changed|insertions|deletions|directories|summary
|
|
111
|
+
|
|
112
|
+
## Field Definitions
|
|
113
|
+
|
|
114
|
+
- **hash**: Use the provided short hash exactly as given
|
|
115
|
+
- **date**: Use the provided date exactly as given
|
|
116
|
+
- **author**: Use the provided author exactly as given
|
|
117
|
+
- **message**: Use the provided first-line message exactly as given. If it contains pipe characters, replace them with dashes.
|
|
118
|
+
- **module**: Classify based on changed file paths (see Module Taxonomy below)
|
|
119
|
+
- **feature**: Classify based on what product area is affected (see Feature Taxonomy below)
|
|
120
|
+
- **impact_type**: One of: feature, enhancement, bugfix, refactor, style, docs, config, infra, revert
|
|
121
|
+
- **severity**: high (new features, breaking changes, major refactors), medium (enhancements, non-trivial fixes), low (typos, style, docs, config tweaks)
|
|
122
|
+
- **breaking**: "yes" if the commit changes APIs, data models, or contracts in backward-incompatible ways. Otherwise "no".
|
|
123
|
+
- **files_changed**: Use the provided pre-computed value exactly as given
|
|
124
|
+
- **insertions**: Use the provided pre-computed value exactly as given
|
|
125
|
+
- **deletions**: Use the provided pre-computed value exactly as given
|
|
126
|
+
- **directories**: Use the provided pre-computed value exactly as given (comma-separated)
|
|
127
|
+
- **summary**: 1-line description of what actually changed, max 15 words. Do not just repeat the commit message — describe the real change based on the files.
|
|
128
|
+
|
|
129
|
+
## Module Taxonomy
|
|
130
|
+
|
|
131
|
+
{MODULE_TAXONOMY}
|
|
132
|
+
|
|
133
|
+
## Feature Taxonomy
|
|
134
|
+
|
|
135
|
+
{FEATURE_TAXONOMY}
|
|
136
|
+
|
|
137
|
+
Pick the best match based on the commit message + file paths. Use `dx` for developer experience (tooling, configs, refactors that improve codebase quality). Use `other` only as a last resort.
|
|
138
|
+
|
|
139
|
+
## Commits to Classify (Batch {BATCH_NUMBER})
|
|
140
|
+
|
|
141
|
+
```json
|
|
142
|
+
{COMMITS_JSON}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Each object has: hash, date, author, message, files (array of changed file paths), files_changed (int), insertions (int), deletions (int), directories (comma-separated string).
|
|
146
|
+
|
|
147
|
+
Classify every commit. Output one row per commit, in the same order as the input. Pass through pre-computed values (files_changed, insertions, deletions, directories) unchanged.
|
|
148
|
+
````
|
|
149
|
+
|
|
150
|
+
If you have more batches than can fit in 5 parallel launches, wait for the first wave to complete, then launch the next wave.
|
|
151
|
+
|
|
152
|
+
## Step 4: Assemble CSV
|
|
153
|
+
|
|
154
|
+
1. Collect all sub-agent outputs
|
|
155
|
+
2. Split each output into lines, trimming whitespace and blank lines
|
|
156
|
+
3. Validate each row has exactly 14 pipe-delimited fields
|
|
157
|
+
4. If a row is malformed, attempt to fix obvious issues (extra/missing pipes). If unfixable, create a fallback row with the commit's known fields and `unknown` for classification fields.
|
|
158
|
+
5. If an entire batch failed, retry it once with the same prompt. On second failure, fallback-classify all commits in that batch.
|
|
159
|
+
6. Prepend the header row: `hash|date|author|message|module|feature|impact_type|severity|breaking|files_changed|insertions|deletions|directories|summary`
|
|
160
|
+
7. Sort data rows by date ascending, then by hash
|
|
161
|
+
8. Write to the output file at project root using the Write tool
|
|
162
|
+
|
|
163
|
+
## Step 5: Classification Summary
|
|
164
|
+
|
|
165
|
+
After writing the CSV, compute and display these statistics by parsing the CSV:
|
|
166
|
+
|
|
167
|
+
- **Author breakdown** — commits per author (descending), breaking changes per author, lines changed per author
|
|
168
|
+
- **Module distribution** — commit count, files changed, and lines changed per module (descending)
|
|
169
|
+
- **Feature distribution** — commit count per feature (descending)
|
|
170
|
+
- **Severity distribution** — count of high / medium / low
|
|
171
|
+
- **Velocity snapshot** — total commits, files changed, insertions, deletions in the period; top 5 directories by commit count; top 5 directories by lines changed
|
|
172
|
+
- **Breaking changes** — list all rows where breaking=yes, showing hash, author, message, module
|
|
173
|
+
|
|
174
|
+
Report the output file path and total row count.
|
|
175
|
+
|
|
176
|
+
### Fallback Classification
|
|
177
|
+
|
|
178
|
+
When a commit cannot be classified by a sub-agent, use these defaults:
|
|
179
|
+
|
|
180
|
+
```
|
|
181
|
+
{hash}|{date}|{author}|{message}|unknown|other|unknown|low|no|{files_changed}|{insertions}|{deletions}|{directories}|Could not classify commit
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
# Phase 2 — Velocity analysis
|
|
187
|
+
|
|
188
|
+
Where Phase 1 classifies _what_ changed, Phase 2 asks _where is change accelerating or decelerating_ — and whether review attention matches the risk. Read the CSV from Phase 1 (or the recent one found in Before Starting).
|
|
189
|
+
|
|
190
|
+
## Step 6: Velocity Heatmap
|
|
191
|
+
|
|
192
|
+
Compute commits-per-directory over rolling windows:
|
|
193
|
+
|
|
194
|
+
- **1 week** — what's hot right now
|
|
195
|
+
- **1 month** — current rhythm
|
|
196
|
+
- **3 months** — quarter-level pattern
|
|
197
|
+
|
|
198
|
+
Aggregate by the top-level directories the CSV's `directories` field already carries (computed generically in Phase 1, Step 2). Report:
|
|
199
|
+
|
|
200
|
+
| Directory | Commits 1w | Commits 1m | Commits 3m | Trend |
|
|
201
|
+
| --------- | ---------: | ---------: | ---------: | ----- |
|
|
202
|
+
|
|
203
|
+
Trend column: ↑ rising, ↓ falling, → steady, ↑↑ sharply rising, ↓↓ sharply falling.
|
|
204
|
+
|
|
205
|
+
## Step 7: Risk Zones
|
|
206
|
+
|
|
207
|
+
For each module with high churn (top quartile in 1m window), check how contract-heavy and how covered it is:
|
|
208
|
+
|
|
209
|
+
- Does its code own cross-cutting contract surfaces (schema/data access, wire handlers, auth/authz, event dispatch, env/config readers)? Skim the module's files to judge — contract-heavy churn is where silent breakage lives.
|
|
210
|
+
- Is the module's owning feature doc up to date? (cross-reference with the maintenance agent's last drift check if available)
|
|
211
|
+
- Do the module's code paths appear under any feature doc's `owns:` globs?
|
|
212
|
+
|
|
213
|
+
Flag risk zones: high churn × contract-heavy × low doc coverage. These are where silent breakage is most likely.
|
|
214
|
+
|
|
215
|
+
## Step 8: Stabilization Signals
|
|
216
|
+
|
|
217
|
+
Identify modules where 1-week and 1-month velocity are both decreasing. Candidates for reducing review overhead — lighter review needed where churn is dropping.
|
|
218
|
+
|
|
219
|
+
## Step 9: Team Distribution
|
|
220
|
+
|
|
221
|
+
Per module, list which authors made the most commits in the 3-month window. Surface concentration risks:
|
|
222
|
+
|
|
223
|
+
- One author > 70% of commits in a critical module → bus-factor flag
|
|
224
|
+
- One author owns all changes touching a contract-heavy surface → review-coverage flag
|
|
225
|
+
|
|
226
|
+
## Step 10: Report & Track
|
|
227
|
+
|
|
228
|
+
### Report format
|
|
229
|
+
|
|
230
|
+
- **Velocity heatmap** (table above)
|
|
231
|
+
- **Risk zones**: top 5 high-churn modules that own contract-heavy surfaces, with the specific contracts at risk named
|
|
232
|
+
- **Stabilization signals**: modules where review overhead can decrease
|
|
233
|
+
- **Concentration risks**: bus-factor and review-coverage flags
|
|
234
|
+
- **Recommendations**: prioritized list — typically "run the `boundary` skill on changes touching X", "add `owns:` coverage for Y to a feature doc", "spread reviews of Z across more authors"
|
|
235
|
+
|
|
236
|
+
### Update tracking
|
|
237
|
+
|
|
238
|
+
1. Write a snapshot to `docs/memory/change-review.md` with date and all four analysis sections above. Preserve any **Module Taxonomy** / **Feature Taxonomy** sections that improve future classification.
|
|
239
|
+
2. Append items to `docs/history/backlog.md`:
|
|
240
|
+
- `- **[P1]** High churn in contract-heavy directory \`{dir}/\` with no doc coverage — discovered by change-review`
|
|
241
|
+
3. Report summary to the user
|
|
242
|
+
|
|
243
|
+
## Rules
|
|
244
|
+
|
|
245
|
+
- Never modify source code — read-only except for writing the output CSV, `docs/memory/change-review.md`, and `docs/history/backlog.md`
|
|
246
|
+
- Use `model: "haiku"` and `subagent_type: "general-purpose"` for all classification sub-agents to minimize cost
|
|
247
|
+
- Always report progress: "Dispatching batch 1-5 of 12..." etc.
|
|
248
|
+
- If git commands fail (bad branch, bad date range), stop and report the error clearly
|
|
249
|
+
- Pipe characters in commit messages must be replaced with dashes before writing to CSV
|
|
250
|
+
- Risk-zone identification judges contract-heaviness from the code itself (Step 7) — no persisted boundary docs exist or are needed
|
|
251
|
+
- A clean report (no risk zones) is valid for a low-churn, well-covered project
|