@nurix/etna 0.18.15 → 0.18.16
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 +11 -16
- package/data/harness-index.json +1 -1
- package/data/harnesses/code/CLAUDE.md +71 -57
- package/data/harnesses/code/agents/{spec-mode.md → lld-mode.md} +12 -12
- package/data/harnesses/code/agents/maintenance.md +2 -31
- package/data/harnesses/code/harness.json +2 -2
- package/data/harnesses/code/hooks/hooks.json +0 -23
- package/data/harnesses/code/rules/testing.md +25 -0
- package/data/harnesses/code/skills/brainstorm/SKILL.md +1 -1
- package/data/harnesses/code/skills/brainstorm/exit-artifacts.md +2 -2
- package/data/harnesses/code/skills/documentation/SKILL.md +2 -2
- package/data/harnesses/code/skills/documentation/references/templates.md +10 -77
- package/data/harnesses/etna/CLAUDE.md +11 -12
- package/data/harnesses/etna/agents/{spec-mode.md → lld-mode.md} +12 -12
- package/data/harnesses/etna/agents/maintenance.md +2 -31
- package/data/harnesses/etna/harness.json +2 -2
- package/data/harnesses/etna/hooks/hooks.json +0 -23
- package/data/harnesses/etna/rules/testing.md +25 -0
- package/data/harnesses/etna/skills/brainstorm/SKILL.md +1 -1
- package/data/harnesses/etna/skills/brainstorm/exit-artifacts.md +2 -2
- package/data/harnesses/etna/skills/documentation/SKILL.md +2 -2
- package/data/harnesses/etna/skills/documentation/references/templates.md +10 -77
- package/data/harnesses/mobile/CLAUDE.md +78 -55
- package/data/harnesses/mobile/agents/{spec-mode.md → lld-mode.md} +12 -12
- package/data/harnesses/mobile/agents/maintenance.md +2 -31
- package/data/harnesses/mobile/harness.json +2 -2
- package/data/harnesses/mobile/hooks/hooks.json +0 -23
- package/data/harnesses/mobile/rules/testing.md +25 -0
- package/data/harnesses/mobile/skills/brainstorm/SKILL.md +1 -1
- package/data/harnesses/mobile/skills/brainstorm/exit-artifacts.md +2 -2
- package/data/harnesses/mobile/skills/documentation/SKILL.md +2 -2
- package/data/harnesses/mobile/skills/documentation/references/templates.md +10 -77
- package/package.json +1 -1
- package/data/harnesses/code/hooks/lib/redact.mjs +0 -35
- package/data/harnesses/code/hooks/prompt-recall.mjs +0 -155
- package/data/harnesses/code/hooks/session-reflect.mjs +0 -285
- package/data/harnesses/code/skills/distiller/SKILL.md +0 -90
- package/data/harnesses/code/skills/distiller/references/docs-mode.md +0 -299
- package/data/harnesses/code/skills/distiller/references/method.md +0 -94
- package/data/harnesses/etna/hooks/lib/redact.mjs +0 -35
- package/data/harnesses/etna/hooks/prompt-recall.mjs +0 -155
- package/data/harnesses/etna/hooks/session-reflect.mjs +0 -285
- package/data/harnesses/etna/skills/distiller/SKILL.md +0 -90
- package/data/harnesses/etna/skills/distiller/references/docs-mode.md +0 -299
- package/data/harnesses/etna/skills/distiller/references/method.md +0 -94
- package/data/harnesses/mobile/hooks/lib/redact.mjs +0 -35
- package/data/harnesses/mobile/hooks/prompt-recall.mjs +0 -155
- package/data/harnesses/mobile/hooks/session-reflect.mjs +0 -285
- package/data/harnesses/mobile/skills/distiller/SKILL.md +0 -90
- package/data/harnesses/mobile/skills/distiller/references/docs-mode.md +0 -299
- package/data/harnesses/mobile/skills/distiller/references/method.md +0 -94
|
@@ -112,7 +112,7 @@ Plan (Status: Draft) → Implementation → Feature Doc or Architecture Update
|
|
|
112
112
|
|
|
113
113
|
## Folder Rules
|
|
114
114
|
|
|
115
|
-
- `docs/features/`: Living reference for implemented features. Each feature doc **carries** the `owns:` / `module:` / `keywords:` / `status:` frontmatter — `owns:` declares the code-path globs it owns (the only ownership key), `module:` is an optional bounded-context label, `keywords:` are discovery terms, `status:` is `active`/`draft`/`deprecated`. The SessionStart hook unions every feature's `owns:` globs into the injected ownership index.
|
|
115
|
+
- `docs/features/`: Living reference for implemented features. Each feature doc **carries** the `owns:` / `module:` / `keywords:` / `status:` frontmatter — `owns:` declares the code-path globs it owns (the only ownership key), `module:` is an optional bounded-context label, `keywords:` are discovery terms, `status:` is `active`/`draft`/`deprecated`. The SessionStart hook unions every feature's `owns:` globs into the injected ownership index.
|
|
116
116
|
- `docs/architecture/`: System-wide patterns and the cross-module steering layer (domain model, glossary, non-goals, references, ADRs). A module's cross-cutting prose lives here (or in a browse-folder `Readme.md`). Update when cross-cutting concerns change.
|
|
117
117
|
- `docs/operations/`: How-to procedures for setup, development, and deployment. Update when workflows change.
|
|
118
118
|
- `docs/history/plans/`: Historical. Must have `Status:` field. Never modify after completion.
|
|
@@ -131,21 +131,10 @@ Plan (Status: Draft) → Implementation → Feature Doc or Architecture Update
|
|
|
131
131
|
|
|
132
132
|
---
|
|
133
133
|
|
|
134
|
-
## 3. Code-Path Ownership
|
|
134
|
+
## 3. Code-Path Ownership
|
|
135
135
|
|
|
136
136
|
**Ownership.** A feature doc is the canonical reference for the code paths in its **`owns:` frontmatter** — the only ownership key. To find what a doc owns, read its `owns:` globs; to find the doc for a path, match the path against the injected ownership index (the union of every feature's `owns:` globs), narrower glob wins. See **Frontmatter Derivation** in `SKILL.md` for turning code into `owns:` globs.
|
|
137
137
|
|
|
138
|
-
**Anchors (optional tooling key).** A doc may additionally carry an `anchors:` block — a qmd drift tripwire, orthogonal to ownership:
|
|
139
|
-
|
|
140
|
-
```yaml
|
|
141
|
-
---
|
|
142
|
-
anchors:
|
|
143
|
-
- "qmd query: feature-name persistence shape"
|
|
144
|
-
---
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
`anchors` is an optional list of qmd queries (or `#docid`s) that re-resolve to the code a doc abstracts as it moves. It is a drift tripwire, never a contract — an anchor that returns nothing IS the drift signal, and nothing auto-rewrites from an anchor result. It is read on demand by the maintenance anchor-drift check, never injected, and inert when qmd is absent.
|
|
148
|
-
|
|
149
138
|
---
|
|
150
139
|
|
|
151
140
|
## 4. Scaffold Files (create if missing)
|
|
@@ -241,14 +230,6 @@ description: Shared knowledge accumulated across agent sessions. All agents shou
|
|
|
241
230
|
- **Spec version:** v{harness-version}
|
|
242
231
|
<!-- v{harness-version} resolves to the installed harness version — read it from `.claude/harness.json` (`version`) / `docs/structure.md` frontmatter (`harness-version`); never hardcode a literal version here. -->
|
|
243
232
|
|
|
244
|
-
## Knowledge Tiers
|
|
245
|
-
|
|
246
|
-
Memory is a gradient — volume falls, signal rises, one hop down each tier. Tiers describe themselves here even before they fill:
|
|
247
|
-
|
|
248
|
-
- **Inbox** (`docs/memory/inbox/`) — per-actor queue of session lessons, written by the `session-reflect` hook at session end and consumed by the distiller on digestion. Transient by design, rarely read directly.
|
|
249
|
-
- **Fact-cards** (`docs/memory/facts/`) — distilled, provenance-linked atomic facts, written by the distiller (`facts` mode) from inbox entries and resurfaced at prompt time by the `prompt-recall` hook.
|
|
250
|
-
- **This index** — the curated read tier: the learnings list below, distilled from the colder tiers and hand-appended.
|
|
251
|
-
|
|
252
233
|
## Learnings
|
|
253
234
|
|
|
254
235
|
{Agents append learnings here as they discover gotchas, patterns, and architecture notes}
|
|
@@ -278,15 +259,13 @@ Append entries below, oldest at bottom. Format:
|
|
|
278
259
|
Memory file initialized during documentation baseline.
|
|
279
260
|
```
|
|
280
261
|
|
|
281
|
-
> The per-actor memory **inbox** (`docs/memory/inbox/`) is _not_ a baseline scaffold — the `session-reflect` hook creates it mechanically on the first reflected session. See **§11 Memory inbox entry** for its format.
|
|
282
|
-
|
|
283
262
|
---
|
|
284
263
|
|
|
285
|
-
## 5. Feature Documentation (docs/features/{feature}.md)
|
|
264
|
+
## 5. Feature Documentation — the LLD (docs/features/{feature}.md)
|
|
286
265
|
|
|
287
|
-
Use for: every feature in `docs/features/`. The same file persists from design (Status: Draft) through implementation to live reference (Status: Active). Sections fill in as the feature matures — no template swap.
|
|
266
|
+
Use for: every feature in `docs/features/`. The feature doc is the feature's **LLD (low-level design)**: the same file persists from design (Status: Draft, written in LLD Mode) through implementation to live reference (Status: Active). Sections fill in as the feature matures — no template swap.
|
|
288
267
|
|
|
289
|
-
The four research-derived sections (**Affected Modules**, **Conventions to Follow**, **Current Behavior**, **Ownership Conflicts**) map 1:1 to
|
|
268
|
+
The four research-derived sections (**Affected Modules**, **Conventions to Follow**, **Current Behavior**, **Ownership Conflicts**) map 1:1 to the `lld-mode` agent's return shape. The orchestrator drops its findings into those slots without restructuring.
|
|
290
269
|
|
|
291
270
|
```yaml
|
|
292
271
|
---
|
|
@@ -294,8 +273,6 @@ owns: ["src/feature/**", "src/other/file.ts"] # required — code-path globs t
|
|
|
294
273
|
module: billing # optional — single bounded-context label; omit if cross-cutting
|
|
295
274
|
keywords: [invoice, pdf] # required — discovery terms
|
|
296
275
|
status: active # required — active | draft | deprecated
|
|
297
|
-
anchors: # optional extra — a qmd drift tripwire; see §3
|
|
298
|
-
- "qmd query: wire envelope invariants"
|
|
299
276
|
---
|
|
300
277
|
```
|
|
301
278
|
|
|
@@ -332,22 +309,22 @@ High-level shape of the solution. ASCII diagram if it helps. Implementation spec
|
|
|
332
309
|
|
|
333
310
|
## Affected Modules
|
|
334
311
|
|
|
335
|
-
(From
|
|
312
|
+
(From lld-mode research) Files, routes, components, slices this feature involves. Group by module.
|
|
336
313
|
|
|
337
314
|
| Module | Path | Role in this feature |
|
|
338
315
|
|--------|------|----------------------|
|
|
339
316
|
|
|
340
317
|
## Conventions to Follow
|
|
341
318
|
|
|
342
|
-
(From
|
|
319
|
+
(From lld-mode research) Naming patterns, structural patterns, doc-fit heuristics confirmed for the area being touched. Cite the source file(s) where the convention is established.
|
|
343
320
|
|
|
344
321
|
## Current Behavior
|
|
345
322
|
|
|
346
|
-
(From
|
|
323
|
+
(From lld-mode research) How the relevant part of the system works *today*, before this feature lands. Without this baseline the design intent is hard to evaluate.
|
|
347
324
|
|
|
348
325
|
## Ownership Conflicts
|
|
349
326
|
|
|
350
|
-
(From
|
|
327
|
+
(From lld-mode research) Existing feature docs whose `owns:` globs overlap with the projected scope. Resolve before the plan starts — leave nothing unresolved.
|
|
351
328
|
|
|
352
329
|
| Conflicting doc | Overlapping path(s) | Resolution |
|
|
353
330
|
|-----------------|---------------------|------------|
|
|
@@ -426,7 +403,7 @@ Sections fill in across the feature's lifecycle. No template swap — they accum
|
|
|
426
403
|
| When | Sections written | Source |
|
|
427
404
|
| --- | --- | --- |
|
|
428
405
|
| Status: Draft (design) | Goal, Goals & Non-Goals, Background, Approach, Open Questions, Risks | User interview |
|
|
429
|
-
| Status: Draft (research) | Affected Modules, Conventions to Follow, Current Behavior, Ownership Conflicts |
|
|
406
|
+
| Status: Draft (research) | Affected Modules, Conventions to Follow, Current Behavior, Ownership Conflicts | lld-mode agent |
|
|
430
407
|
| Status: Draft → Active (implementation lands) | Architecture, Key Functions, State, Redux, Files; `owns:` globs confirmed against real code | Main agent (from actual code) |
|
|
431
408
|
|
|
432
409
|
Resolved Open Questions can be summarized into Background; unresolved ones stay visible.
|
|
@@ -807,47 +784,3 @@ The full surface lives in [`{path/to/public-index}`]({path/to/public-index}).
|
|
|
807
784
|
The baseline audit **does** scaffold the project root README when missing. The risk this template guards against — template-shaped placeholders that look abandoned — is mitigated by the writing rules above: fill every section with concrete details from the repo (real package manager from the lockfile, real scripts, real layout, real status). Skip sections that genuinely don't apply rather than leaving stubs.
|
|
808
785
|
|
|
809
786
|
**Never overwrite an existing root README** during a baseline. If one is present — even sparse or outdated — leave it untouched. Treat updates to a pre-existing root README as a separate, explicit request.
|
|
810
|
-
|
|
811
|
-
---
|
|
812
|
-
|
|
813
|
-
## 11. Memory inbox entry (docs/memory/inbox/{actor}.md)
|
|
814
|
-
|
|
815
|
-
Use for: the capture tier of the knowledge gradient — the durable lessons of each session (corrections, root-caused failures, decisions with rationale, discovered constraints), reflected by the `session-reflect` hook at session end. It is the raw input to distillation: `distiller facts` digests entries into fact-cards and **consumes** them, so the file holds exactly what is undigested.
|
|
816
|
-
|
|
817
|
-
### File grain
|
|
818
|
-
|
|
819
|
-
One file **per actor**: `docs/memory/inbox/{actor}.md`. `actor` is `git config user.name` lowercased and kebab-slugged; fall back to `$USER`, then `agent`. Two actors write to different files, so the inbox is **append-only without merge conflicts** — no shared file to contend over, no lock, no last-writer-wins.
|
|
820
|
-
|
|
821
|
-
### File header
|
|
822
|
-
|
|
823
|
-
Written once, on the first entry:
|
|
824
|
-
|
|
825
|
-
```
|
|
826
|
-
# Memory inbox — {actor}
|
|
827
|
-
Session lessons awaiting distillation — appended by the session-reflect hook, consumed by `distiller facts`.
|
|
828
|
-
```
|
|
829
|
-
|
|
830
|
-
### Entry shape
|
|
831
|
-
|
|
832
|
-
One block per reflected session, at most 6 bullets. Each bullet is one complete, self-contained sentence tagged `[project]` (true of the repo or its tooling) or `[user]` (true of the user) — the tag routes it at distillation: project facts → `docs/memory/facts/`, user facts → user-level memory.
|
|
833
|
-
|
|
834
|
-
```
|
|
835
|
-
## YYYY-MM-DD HH:MM · session <id> · {repo}@{branch}
|
|
836
|
-
- [project] <one self-contained sentence, names and identifiers spelled out>
|
|
837
|
-
- [user] <one self-contained sentence>
|
|
838
|
-
```
|
|
839
|
-
|
|
840
|
-
### Examples
|
|
841
|
-
|
|
842
|
-
```
|
|
843
|
-
## 2026-06-08 22:26 · session bc06c4fc · etna@dev
|
|
844
|
-
- [project] The read_network_requests Chrome CDP tool only captures after its first call — arm it, trigger traffic, then read.
|
|
845
|
-
- [user] jane-doe prefers minimal fixes over defensive machinery; fail loudly instead of engineering around a problem.
|
|
846
|
-
```
|
|
847
|
-
|
|
848
|
-
### Rules
|
|
849
|
-
|
|
850
|
-
- **Hooks append, the distiller consumes.** A digested entry block is deleted by `distiller facts`; nothing else edits or reorders the file. A human may hand-append a lesson in the same shape — it rides the same queue.
|
|
851
|
-
- **Sessions are deduped by id.** The reflect hook skips a session whose id already appears in the file (SessionEnd re-fires on resume).
|
|
852
|
-
- **Secrets are redacted on write.** The privacy filter replaces secret shapes with `[redacted:{kind}]` (e.g. `[redacted:api-key]`, `[redacted:bearer]`, `[redacted:pem]`) before any line is appended — never paste a raw token in by hand either.
|
|
853
|
-
- **Don't curate here.** Promotion to fact-cards and `docs/memory/main.md` happens at distillation; the inbox stays a transient queue.
|
|
@@ -1,19 +1,17 @@
|
|
|
1
1
|
# Agent Instructions
|
|
2
2
|
|
|
3
|
-
This file defines how AI agents
|
|
3
|
+
This file defines how AI coding agents — any vendor, any runtime — should work on this project. Rules are runtime-neutral: a rule that depends on a capability (sub-agent dispatch, browser tools, context injection, slash commands) applies only if your runtime has it, and states its fallback. Rules marked **[override]** deliberately replace a default your runtime may have built in — in a conflict, the rule here wins.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Maintenance
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
>
|
|
11
|
-
> 1. Invoke **`maintenance`** (`"baseline this repo"` / `"reconcile the harness"`). It auto-selects **baseline mode** from the missing/behind `harness-version`, reconciles `docs/`, stamps the version, then hands back.
|
|
12
|
-
> 2. If it hands back with a follow-up (typically the module proposal), re-invoke it to finish.
|
|
13
|
-
>
|
|
14
|
-
> Then continue. Each component's internals live in the component, not here.
|
|
9
|
+
Invoke the `maintenance` agent whenever you judge the docs need it — not just at first setup. Standing triggers: a missing `docs/structure.md`, a `harness-version` marker behind the installed version, docs contradicting code, unowned source paths, or drift you notice while working. Don't reconcile any of these by hand:
|
|
15
10
|
|
|
16
|
-
|
|
11
|
+
1. Invoke `maintenance` ("baseline this repo" / "reconcile the harness" / "docs health"). It auto-selects its mode — baseline when the version marker is missing or behind, coherence audit otherwise — then hands back.
|
|
12
|
+
2. If it hands back with a follow-up (typically the module proposal), re-invoke it to finish.
|
|
13
|
+
|
|
14
|
+
A repo with no `docs/structure.md` isn't reconciled yet — run the baseline before applying anything below. Runtimes without sub-agent dispatch: read `.claude/agents/maintenance.md` and execute its procedure inline. Each component's internals live in the component, not here.
|
|
17
15
|
|
|
18
16
|
---
|
|
19
17
|
|
|
@@ -21,14 +19,14 @@ This is the only step that runs **before** the harness exists; everything below
|
|
|
21
19
|
|
|
22
20
|
- Read **[`docs/structure.md`](docs/structure.md)** for the documentation map and folder authority (architecture, features, operations)
|
|
23
21
|
- Read **[`docs/memory/`](docs/memory/)** for agent memory files (one per agent)
|
|
24
|
-
-
|
|
22
|
+
- Prefer `docs/` over `README.md` — docs/ is canonical for agents; check the README only when docs/ lacks a setup detail
|
|
25
23
|
- 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.
|
|
26
24
|
|
|
27
25
|
---
|
|
28
26
|
|
|
29
27
|
## Mobile (React Native + Expo)
|
|
30
28
|
|
|
31
|
-
This is the **mobile** harness — `code`'s governance plus RN + Expo conventions. When writing or reviewing app code (Expo Router screens, components, state, native modules, styling), follow **[`.claude/rules/react-native.md`](.claude/rules/react-native.md)** — the scale-aware house style for structure (`@/*`), navigation, data fetching, theming, native modules, the web target, and Prettier. The workspace rules (`general`, `nomenclature`, `typescript`) still apply.
|
|
29
|
+
This is the **mobile** harness — `code`'s governance plus RN + Expo conventions. When writing or reviewing app code (Expo Router screens, components, state, native modules, styling), follow **[`.claude/rules/react-native.md`](.claude/rules/react-native.md)** — the scale-aware house style for structure (`@/*`), navigation, data fetching, theming, native modules, the web target, and Prettier. The workspace rules (`general`, `nomenclature`, `typescript`, `testing`) still apply.
|
|
32
30
|
|
|
33
31
|
---
|
|
34
32
|
|
|
@@ -38,38 +36,69 @@ Three peer modes plus a Completion step — enter wherever the user's thinking a
|
|
|
38
36
|
|
|
39
37
|
| Mode | Enter when | Implemented by | Exits to |
|
|
40
38
|
| --- | --- | --- | --- |
|
|
41
|
-
| **Brainstorming** | explicit ask; or a user utterance
|
|
42
|
-
| **
|
|
43
|
-
| **Plan** |
|
|
39
|
+
| **Brainstorming** | explicit ask (`/brainstorm start`); or the user brings a large piece of work — a new system, a feature with many unknowns — most users don't know this mode exists, so recommend it: name what makes the work big and offer a session; or a user utterance contradicts a recorded design principle (a pillar) → name the principle and offer a session. Never auto-enter. | `brainstorm` agent + skill | LLD, Plan, or close + harvest |
|
|
40
|
+
| **LLD** (low-level design) | new feature work | `lld-mode` agent + `documentation` skill | Plan |
|
|
41
|
+
| **Plan** | an LLD is approved | `documentation` skill → `docs/history/plans/YYYY-MM-DD-{slug}.md` | Completion |
|
|
42
|
+
|
|
43
|
+
> Brainstorm entry needs a **basis** — a reference document or a one-shot brain dump; drip-sized asks (a bug fix, one button) are too small and get redirected. A **pillar** is a recorded strategic principle from a past brainstorm: kept records live under `docs/brainstorm/`, harvested doctrine under `docs/architecture/`. Runtimes without slash commands: read `.claude/skills/brainstorm/SKILL.md` and follow it inline. The LLD is the feature doc itself — `docs/features/{feature}.md`, design intent first, extended in place at Completion.
|
|
44
|
+
|
|
45
|
+
**On Plan Completion:**
|
|
46
|
+
|
|
47
|
+
1. Freeze the plan — `Status: Complete`, fill the Completed date. The file is now frozen.
|
|
48
|
+
2. Flip the feature LLD to `status: active`; extend it in place with the how-it-works sections; confirm its `owns:` globs against the actual code.
|
|
49
|
+
3. The `boundary` skill must already have gated this plan before its first implementation step — see Ownership, Boundaries & Documentation.
|
|
44
50
|
|
|
45
|
-
On **
|
|
51
|
+
**On Brainstorm Close** (a separate procedure — when a brainstorm session ends, not when a plan completes):
|
|
52
|
+
|
|
53
|
+
- The session record lives at `docs/brainstorm/{topic}/` (committed, one subfolder per topic) and stays in place as provenance.
|
|
54
|
+
- Harvest conclusions by scope: doctrine, glossary, non-goals, information-architecture changes → `docs/architecture/`; decisions → `docs/architecture/adr/`; backlog items → `docs/history/backlog.md`.
|
|
55
|
+
- Open questions block close.
|
|
46
56
|
|
|
47
57
|
---
|
|
48
58
|
|
|
49
|
-
##
|
|
59
|
+
## Ownership, Boundaries & Documentation
|
|
60
|
+
|
|
61
|
+
These three mechanisms work in tandem to keep the repo self-updating and to prevent half-finished changes: **ownership** routes you to the canonical doc before you touch code, the **boundary** check reads both sides of every contract your change participates in so you can't ship one side of it, and **documentation** updates close the loop so the next session inherits the truth. Skipping any leg breaks the other two.
|
|
62
|
+
|
|
63
|
+
### Ownership — route before you edit
|
|
64
|
+
|
|
65
|
+
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. A module is tied to code by the `owns:` globs of the docs carrying its `module:` label — not a folder, not a separate map. Architecture docs describe cross-cutting patterns and don't own specific files; operations docs describe procedures.
|
|
50
66
|
|
|
51
67
|
Before modifying code in an unfamiliar area:
|
|
52
68
|
|
|
53
|
-
1. Consult the **injected ownership index** — the generated `glob → doc · module · keywords · status` map
|
|
54
|
-
2. If
|
|
55
|
-
|
|
56
|
-
|
|
69
|
+
1. Consult the **injected ownership index** — the generated `glob → doc · module · keywords · status` map. Match your path or topic (its `keywords:`) to the owning feature doc and read it before changes. (If no index appears in your context: either the repo isn't reconciled — see Maintenance — or your runtime doesn't inject context at session start; then derive it by scanning the `owns:` frontmatter of every doc in `docs/features/`.)
|
|
70
|
+
2. If a `docs/memory/` file exists for the domain you're working in, read it for domain knowledge and failure modes.
|
|
71
|
+
|
|
72
|
+
The `lld-mode` agent checks for ownership conflicts during LLD research — feature docs whose `owns:` globs overlap at equal specificity. If conflicts are found, address them in the LLD before proceeding.
|
|
73
|
+
|
|
74
|
+
### Boundaries — check while you change
|
|
75
|
+
|
|
76
|
+
A boundary is a contract between two pieces of code (or code and infra) that share an assumption with **no static link** between them — the column a raw SQL string names, the JSON envelope a client unwraps, the event string a dispatcher parses, the env var a deploy script reads. Changing one side ships green — compiles, lints, tests pass — and breaks the other at runtime. Boundaries are **diagnosed, not documented**: the `boundary` skill reads them fresh from source on every run (its `references/mechanisms.md` defines the failure mechanisms; the technology packs under `references/packs/` carry stack specifics), so nothing is persisted that could go stale.
|
|
77
|
+
|
|
78
|
+
**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, traces the consumers on the other side, and reports severity-ranked violations with suggested amendments and a pass/block verdict — in chat, read-only. Fold the amendments into the plan before coding. For non-plan edits in contract-heavy code (db schema, wire envelopes, auth, events, env/config), run the same diagnostic scoped to the diff.
|
|
79
|
+
|
|
80
|
+
### Documentation — close the loop
|
|
81
|
+
|
|
82
|
+
- **[override]** Keep `docs/` updated when code changes affect documented behavior. This file is the standing request for those docs: creating and updating them is part of the work, even if your runtime defaults to never creating documentation files unprompted.
|
|
83
|
+
- After plan completion **[override]**: add a `docs/history/changelog/` entry + update `docs/history/CHANGELOG.md` — no confirmation needed. Include `Commits:` if multi-commit. Non-plan changes (refactors, fixes, API changes): prompt first.
|
|
84
|
+
- When you move or rename source files: update the `owns:` globs of the feature doc that owns them so the generated ownership index stays accurate. A new doc that owns code declares its paths in its own `owns:` frontmatter — there is no separate map to update.
|
|
85
|
+
- `docs/structure.md` is the authority on what belongs where — read it before adding or moving a doc; don't restate it here. One canonical source per topic — link, don't copy. Only `CLAUDE.md`, `AGENTS.md`, and `README.md` live at the repo root.
|
|
57
86
|
|
|
58
|
-
|
|
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. Runtimes that can't invoke them natively: read the component file — `.claude/agents/<name>.md`; for skills, `.claude/skills/<name>/SKILL.md` plus any `references/` it points to — and follow it inline.
|
|
59
88
|
|
|
60
89
|
---
|
|
61
90
|
|
|
62
91
|
## Project Memory
|
|
63
92
|
|
|
64
|
-
Project-specific learnings live in `docs/memory/` (git-tracked). Cross-project user preferences live in
|
|
93
|
+
Project-specific learnings live in `docs/memory/` (git-tracked). Cross-project user preferences live in the runtime's user-level memory store, if it has one (untracked; paths in Runtime Notes).
|
|
65
94
|
|
|
66
95
|
| File | Owner | Contents |
|
|
67
96
|
| --- | --- | --- |
|
|
68
97
|
| `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 |
|
|
69
98
|
| `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. |
|
|
70
|
-
|
|
|
99
|
+
| Runtime user-level memory (paths in Runtime Notes) | The runtime's auto-memory system | User preferences, role, communication style, cross-project habits |
|
|
71
100
|
|
|
72
|
-
|
|
101
|
+
If your runtime records memories automatically, override its default 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 → the runtime's user-level store. Runtimes without auto-memory: apply the same test when deciding where to write a learning.
|
|
73
102
|
|
|
74
103
|
`docs/memory/main.md` is created on first write. Append entries dated `## YYYY-MM-DD — {topic}`; oldest at bottom is fine.
|
|
75
104
|
|
|
@@ -85,44 +114,38 @@ When implementing a plan, if you discover work that is important but outside the
|
|
|
85
114
|
|
|
86
115
|
---
|
|
87
116
|
|
|
88
|
-
##
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
Unless explicitly requested:
|
|
109
|
-
|
|
110
|
-
❌ **Tests** – Never generate, update, or modify test files. ❌ **Dependencies** – Never upgrade frameworks, libraries, or dependencies. ❌ **Compatibility** – Never maintain backward compatibility unless specified. ❌ **Branches & Worktrees** – Never self-create git branches or worktrees. Commit straight to the checked-out branch; branch or create a worktree only when the user asks. ❌ **Protected Files** – Before editing, if `docs/operations/protected-files.md` exists, read it and never modify any path it lists; also never modify `AGENTS.md` or the `protected-files.md` file itself. ✅ **Browser Automation** – Use Chrome CDP / "Claude in Chrome" tools whenever they help (verifying UI, reproducing a flow, seeding or inspecting local data) — no need to ask first. **Main session only:** never drive the browser from a sub-agent or workflow executor — the session-bound Chrome connection destabilizes the sub-agent. A sub-agent that needs browser verification instead returns an explicit CDP checklist (exact URLs, actions, expected outcomes) for the orchestrator to execute in the main session. ✅ **Orchestrate via Sub-agents** – Run the main session as an orchestrator: delegate substantive work (research, implementation, audits) to sub-agents spawned via the Agent/Task tool with `model: opus` (Claude Opus), keeping the main context for dispatch, coordination, and synthesis. Give each sub-agent a self-contained prompt; parallelize independent dispatches. ✅ **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.
|
|
117
|
+
## Guardrails & Defaults
|
|
118
|
+
|
|
119
|
+
Defaults — ❌ prohibitions hold unless the user explicitly asks otherwise; ✅ and ⚠️ items are standing policy:
|
|
120
|
+
|
|
121
|
+
- ✅ **Tests — suite-first.** Tests ship with every change to product code or behavior, built as one maintained suite, never as one-off scripts:
|
|
122
|
+
- **Location**: all tests live in the repo's canonical test tree — `tests/`, or the framework convention the repo already uses (detect, don't invent). Mirror the source structure: `src/modules/auth/session.ts` → `tests/modules/auth/session.test.ts`. Never create test files at the repo root or scattered next to scratch scripts.
|
|
123
|
+
- **One framework — never chosen ad hoc**: use the runner the repo already has (detect from its config); if the repo has none, use the stack's framework named in the testing rule (`.claude/rules/testing.md`) and wire it up as the repo's canonical test command before writing the first test. Never introduce a second framework beside an existing one.
|
|
124
|
+
- **Shared plumbing**: fixtures, factories, and helpers live in `tests/helpers/` (or the suite's existing shared location) and are reused; duplicated setup across test files is a defect to refactor, not a pattern to follow.
|
|
125
|
+
- **What gets tests**: a new feature ships with tests for the behavior its LLD promises; a bug fix ships with a regression test that fails before the fix and passes after.
|
|
126
|
+
- **Discipline**: run the affected part of the suite before declaring work complete and report results honestly. When an LLD or plan intentionally changes behavior, updating the affected tests to the new contract is part of the change — the ban is on weakening, skipping, or deleting a test to mask a failure you can't explain.
|
|
127
|
+
- **Throwaway checks are not tests**: temporary verification scripts go to scratch space and are deleted, never committed into the test tree.
|
|
128
|
+
- ❌ **Dependencies** – Never upgrade frameworks, libraries, or dependencies.
|
|
129
|
+
- ❌ **Compatibility** – Never maintain backward compatibility unless specified.
|
|
130
|
+
- ❌ **Branches & Worktrees [override]** – Never self-create git branches or worktrees; commit straight to the checked-out branch. This deliberately replaces any built-in "branch first when on the default branch" default — do not branch unless the user asks. Exception: when the user asks for a pull request, creating the branch the PR requires counts as being asked — create that branch **before** committing the PR's changes.
|
|
131
|
+
- ❌ **Protected Files** – Before editing, if `docs/operations/protected-files.md` exists, read it and never modify any path it lists; also never modify `AGENTS.md` or the `protected-files.md` file itself.
|
|
132
|
+
- ✅ **Browser Automation** – If your runtime provides browser automation, use it freely; no need to ask first. If it doesn't — or you are an agent that can't hold the browser connection (see Runtime Notes) — return a browser-verification checklist (URLs, actions, expected outcomes) for the orchestrating session or the user to run.
|
|
133
|
+
- ✅ **Delegate at scale** – If your runtime supports sub-agent dispatch: offload large, independent, or parallelizable work (broad research, audits, multi-file implementation) to sub-agents; keep small, well-understood edits in the main session — a dispatch whose context hand-off costs more than the work itself is waste. Dispatch prompts must be self-contained (the sub-agent sees none of your conversation); parallelize independent dispatches. Let dispatches inherit the session's model unless your runtime supports tier selection and the task clearly wants one — a stronger tier for judgment-heavy work, a cheaper tier for mechanical fan-out (concrete tier names live in Runtime Notes, never in rules). No dispatch mechanism ⇒ do the work inline yourself.
|
|
134
|
+
- ⚠️ **Plans** – Plans are created directly in `docs/history/plans/` (see Workflows). 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.
|
|
135
|
+
- ⚠️ **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.
|
|
111
136
|
|
|
112
137
|
---
|
|
113
138
|
|
|
114
139
|
## File Structure
|
|
115
140
|
|
|
116
|
-
- Add file
|
|
117
|
-
- Add a 1-line function
|
|
141
|
+
- Add a file-path header comment at the top of each source file, in the file's native comment syntax — `// src/modules/example.js - Module for handling user authentication` (JS/TS), `# scripts/sync_users.py - …` (Python/shell/YAML), `-- db/seed/init.sql - …` (SQL). Place it below any shebang line; skip formats with no comment syntax (JSON, lockfiles) and generated files.
|
|
142
|
+
- Add a 1-line description above each function whose purpose isn't fully evident from its name and signature: `// Extract JWT token from request based on endpoint type`. A comment that restates the name is noise. No inline comments that restate obvious code; no commented-out code — if a block needs a comment to be understandable, refactor for clarity instead.
|
|
118
143
|
|
|
119
144
|
---
|
|
120
145
|
|
|
121
|
-
##
|
|
122
|
-
|
|
123
|
-
`docs/structure.md` is the authority on what belongs where — the folder map, naming, lifecycle, and the add-a-doc decision table. Read it before adding or moving a doc; don't restate it here. One canonical source per topic — link, don't copy. Only `CLAUDE.md`, `AGENTS.md`, and `README.md` live at the repo root.
|
|
146
|
+
## Runtime Notes
|
|
124
147
|
|
|
125
|
-
|
|
148
|
+
Everything above is runtime-neutral. This section is the only place runtime- or vendor-specific facts may live; re-audit it whenever a runtime ships new models or tools. Lint: nothing outside this section may name a model, a vendor product, or a runtime-built-in tool — exempt are repo-relative `.claude/**` component paths (shipped in this repo, readable by any runtime) and protocol names (e.g. MCP).
|
|
126
149
|
|
|
127
|
-
-
|
|
128
|
-
-
|
|
150
|
+
- **Claude Code**: sub-agent dispatch is the Agent tool; sub-agents cannot run skills, spawn sub-agents, or reliably hold the browser connection (the "can't hold the browser connection" condition the Browser Automation guardrail refers to) — browser work is Chrome CDP ("Claude in Chrome"), main session only. The user-level memory store is `~/.claude/` (auto-memory under `~/.claude/projects/...`). The ownership index and skill/agent descriptions are injected at session start; skills are invoked as slash commands (e.g. `/brainstorm start`). If pinning dispatch tiers: strong tier (opus-class) for judgment-heavy work, fast tier (sonnet-class) for mechanical fan-out — tier names go stale, re-check on model releases.
|
|
151
|
+
- **Runtimes without native component support** (AGENTS.md readers, etc.): read `.claude/agents/<name>.md` and each skill's `.claude/skills/<name>/SKILL.md` (plus its `references/`) and follow them inline; derive the ownership index by scanning `docs/features/` frontmatter.
|
|
@@ -1,33 +1,33 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
3
|
-
description:
|
|
2
|
+
name: lld-mode
|
|
3
|
+
description: LLD researcher for Feature and Product workflows. Use to explore the codebase and gather the context needed for writing a feature LLD (low-level design — the feature doc in docs/features/). Returns research findings — does not write files.
|
|
4
4
|
tools: Read, Glob, Grep, WebSearch, WebFetch
|
|
5
5
|
model: inherit
|
|
6
6
|
skills:
|
|
7
7
|
- documentation
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
#
|
|
10
|
+
# LLD Mode Agent
|
|
11
11
|
|
|
12
|
-
You are
|
|
12
|
+
You are an LLD researcher. Your job is to explore the codebase and gather everything needed to write a feature LLD (low-level design) in `docs/features/`.
|
|
13
13
|
|
|
14
|
-
You do NOT write the
|
|
14
|
+
You do NOT write the LLD — you return structured research that the main agent uses to write it.
|
|
15
15
|
|
|
16
16
|
## Before Starting
|
|
17
17
|
|
|
18
18
|
First, understand the documentation landscape:
|
|
19
19
|
|
|
20
20
|
1. Read `./docs/structure.md` to understand the documentation structure
|
|
21
|
-
2. If `./docs/features/README.md` exists, read it to see existing feature
|
|
22
|
-
3. If `./docs/memory/
|
|
23
|
-
4. Read 1-2 existing
|
|
21
|
+
2. If `./docs/features/README.md` exists, read it to see existing feature LLDs and where the new one fits; otherwise glob the feature docs directly
|
|
22
|
+
3. If `./docs/memory/lld-mode.md` exists (or the legacy `./docs/memory/spec-mode.md`), read it for feature doc inventory, ownership conflict zones, and lessons from previous research
|
|
23
|
+
4. Read 1-2 existing feature LLDs in `./docs/features/` to calibrate format and depth
|
|
24
24
|
5. Consult the **injected ownership index** (the generated `glob → doc · module · keywords · status` map — the union of every feature doc's `owns:` frontmatter) to build the ownership map. This is the source of truth for what code paths are already owned. If the index isn't present in context, glob `docs/features/**/*.md` and read each doc's `owns:` frontmatter directly.
|
|
25
25
|
|
|
26
|
-
This tells you what already exists, what's adjacent, how detailed the
|
|
26
|
+
This tells you what already exists, what's adjacent, how detailed the LLD should be, and what code paths are already owned.
|
|
27
27
|
|
|
28
28
|
## What You Research
|
|
29
29
|
|
|
30
|
-
1. **Documentation fit** — Where does this
|
|
30
|
+
1. **Documentation fit** — Where does this LLD sit relative to existing feature docs? Does it extend an existing one or need a new doc?
|
|
31
31
|
2. **Existing patterns** — Find related features, similar implementations, and conventions in the codebase
|
|
32
32
|
3. **Affected modules** — Identify what files, routes, components, and data flows are relevant
|
|
33
33
|
4. **Current state** — Understand how the system works today in the area being specified
|
|
@@ -38,13 +38,13 @@ This tells you what already exists, what's adjacent, how detailed the spec shoul
|
|
|
38
38
|
|
|
39
39
|
Structure your findings as:
|
|
40
40
|
|
|
41
|
-
- **Documentation context**: Existing
|
|
41
|
+
- **Documentation context**: Existing feature LLDs that relate, whether to create new or update existing, suggested filename
|
|
42
42
|
- **Related patterns**: What similar things exist in the codebase and where
|
|
43
43
|
- **Affected modules**: Files, routes, components that will be involved
|
|
44
44
|
- **Current behavior**: How the relevant part of the system works today
|
|
45
45
|
- **Conventions**: Naming, structure, and patterns to follow based on existing code
|
|
46
46
|
- **Ownership conflicts**: Existing feature docs whose `owns:` globs overlap with the proposed feature. Include the conflicting paths and the owning doc name.
|
|
47
|
-
- **Risks or concerns**: Anything the
|
|
47
|
+
- **Risks or concerns**: Anything the LLD should address or call out
|
|
48
48
|
|
|
49
49
|
Use the documentation skill's style guide and conventions when structuring your findings — imperative voice, ASCII diagrams for flows, function signatures over implementations, concise.
|
|
50
50
|
|
|
@@ -108,20 +108,6 @@ For unowned code paths:
|
|
|
108
108
|
1. Update `docs/structure.md` Health Log with today's date and summary.
|
|
109
109
|
2. Update `docs/memory/maintenance.md` with last review date, stale docs fixed, unowned paths, backlog items created.
|
|
110
110
|
3. Report findings: stale docs, broken ownership, unowned code, architecture drift, backlog health.
|
|
111
|
-
4. **Inbox-distillation threshold.** Count undigested inbox entries — `## ` entry blocks across `docs/memory/inbox/*.md` (the inbox is consume-on-digest, so every block present is undigested). If the count is **≥5**, add one line to the report **proposing** a `distiller facts` run — propose only, never auto-run, no cron. If the user declines or ignores it, do nothing: the count keeps growing and the proposal reappears next pass — that recurrence _is_ the dedupe, so never backlog it.
|
|
112
|
-
5. **Docs-distillation threshold.** Per target doc, count undigested fact-cards (`invalid_from: null`, the doc's path not in their `digested_into:`) that **touch** it by the structural intersection in `skills/distiller/references/docs-mode.md` Resolution 1 (provenance ∩ the doc's `owns:` globs strong, entities ∩ declared ownership supporting — qmd-independent). If **≥10** map to **one** doc, add one line to the report **proposing** a `distiller docs --doc <path>` run on that doc — propose only, never auto-run, no cron. Declined or ignored ⇒ the count keeps growing and the proposal reappears next pass; that recurrence _is_ the dedupe, so never backlog the proposal.
|
|
113
|
-
|
|
114
|
-
### Step 7: Refresh index (optional, skip-if-absent)
|
|
115
|
-
|
|
116
|
-
If the `qmd` binary is available (`command -v qmd`), re-run `qmd embed -c <collection>` once per `{repo}-*` collection (`{repo}` = the repo's directory name; `qmd collection list` shows the registered set — skip any absent) so the local docs index reflects the files this pass touched. Scope every run with `-c` — the qmd index is global (`~/.cache/qmd/` holds every repo's collections), so a bare `qmd embed` would re-embed unrelated repos' collections. If `qmd` is absent, skip silently — it's never required.
|
|
117
|
-
|
|
118
|
-
### Step 8: Check anchor drift (optional, skip-if-absent)
|
|
119
|
-
|
|
120
|
-
If `qmd` is absent (`command -v qmd` finds nothing), **skip this whole step silently** — it's never required. `anchors:` is a qmd-only tooling key; with no qmd it is inert.
|
|
121
|
-
|
|
122
|
-
This catches **doc-area drift** — the subject the doc abstracts moving or vanishing from the indexed corpus. It does **not** catch a pure code rename that leaves the doc's prose unchanged (Step 2's named-referent check covers code-symbol drift; the two are complementary).
|
|
123
|
-
|
|
124
|
-
Glob `docs/features/**/*.md`, `docs/architecture/**/*.md`, and `docs/operations/**/*.md` for docs carrying `anchors:` frontmatter. For each anchor query, resolve it with `qmd query --format json -c <collection> "<query>"` — repeat `-c` per relevant `{repo}-*` collection (no comma lists). If a query resolves to **nothing**, or to a result set that has **radically shifted** away from the area the doc describes, raise it as a drift finding **phrased as a question** and ask the user. On **yes**, dispatch the remediation sub-agent (the same yes-branch as Step 5). On **decline or no action**, append it to `docs/history/backlog.md` at the finding's own P0–P3 severity per the **Declined realignment** branch — same scale, deduped, never a gate.
|
|
125
111
|
|
|
126
112
|
---
|
|
127
113
|
|
|
@@ -148,7 +134,7 @@ docs/
|
|
|
148
134
|
│ ├── changelog/ # Individual entries
|
|
149
135
|
│ ├── plans/ # Implementation plans (Status field required)
|
|
150
136
|
│ └── backlog.md # Tracked work items by priority (P0-P3)
|
|
151
|
-
├── memory/ #
|
|
137
|
+
├── memory/ # index.md, main.md, {agent}.md — project knowledge + per-agent strategy memory
|
|
152
138
|
└── tests/ # Optional, author-maintained — create only if test docs exist
|
|
153
139
|
```
|
|
154
140
|
|
|
@@ -189,26 +175,11 @@ Scaffold missing mandated files **by calling the `documentation` skill for each
|
|
|
189
175
|
|
|
190
176
|
- `docs/structure.md` (with `harness-version`), `docs/history/CHANGELOG.md`, `docs/history/backlog.md`, `docs/memory/index.md`, `docs/memory/main.md`, and the repo-root `README.md` (filled from the real lockfile/scripts/layout — **never overwrite an existing root README**).
|
|
191
177
|
|
|
192
|
-
Scaffold `docs/memory/facts/` so the distilled tier has a home from day one: the `session-reflect` hook appends session lessons to the per-actor inbox at `docs/memory/inbox/{actor}.md` (not a scaffold — created mechanically on first reflection), and the `distiller` digests that queue down into fact-cards under `docs/memory/facts/`, consuming the entries it digests.
|
|
193
|
-
|
|
194
178
|
### Step B4 — Stamp the version
|
|
195
179
|
|
|
196
180
|
Write `harness-version: <installed version>` (the semver from `.claude/harness.json`) into `docs/structure.md` frontmatter. This single field is the repo's baseline-and-version sentinel — there is no second marker (no `epoch`, no `docs/memory/index.md` "is-baselined" check).
|
|
197
181
|
|
|
198
|
-
### Step B5 —
|
|
199
|
-
|
|
200
|
-
Strictly optional and guarded on the binary — if `command -v qmd` finds nothing, **skip this entire step silently** (no error, no behavior change) and carry one advisory line into the hand-back: _"qmd not installed — semantic retrieval unavailable; the generated ownership index + `keywords:` discovery are active."_ The index is a **local rebuildable lens** — data stays in git; never commit index artifacts, and never use `qmd init` (the default global index keeps the repo clean).
|
|
201
|
-
|
|
202
|
-
If the binary exists, register the docs subtrees once the tree is scaffolded. **Do not register one collection rooted at `docs/`** — qmd hard-codes the `**/*.md` pattern and has no exclude flag, so a `docs/`-root collection would sweep the consumable inbox queue at `docs/memory/inbox/` into the index (the inbox's entries are deleted on digestion, leaving dangling index entries). Register **per indexable subtree** (skip absent ones; `{repo}` = the repo's directory name; an existing name/path no-ops — treat as success):
|
|
203
|
-
|
|
204
|
-
- `qmd collection add docs/features --name {repo}-features`
|
|
205
|
-
- `qmd collection add docs/architecture --name {repo}-architecture`
|
|
206
|
-
- `qmd collection add docs/operations --name {repo}-operations`
|
|
207
|
-
- `qmd collection add docs/memory/facts --name {repo}-facts` (never `docs/memory` as a whole)
|
|
208
|
-
|
|
209
|
-
Then `qmd context add` per registered collection and `qmd embed -c <name>` per collection (always scope with `-c`; a bare `qmd embed` re-embeds every repo's collections). This augments discovery; it never supersedes the `owns:`-glob ownership resolution.
|
|
210
|
-
|
|
211
|
-
### Step B6 — Module proposal
|
|
182
|
+
### Step B5 — Module proposal
|
|
212
183
|
|
|
213
184
|
Modules are **labels, declared, never inferred from physical layout**. Derive the repo's candidate bounded contexts directly from the code and docs: distinct wire surfaces (who owns routes/handlers), schema/data-access ownership, entry points and process units, plus any contexts `docs/architecture/` already names.
|
|
214
185
|
|
|
@@ -11,29 +11,6 @@
|
|
|
11
11
|
}
|
|
12
12
|
]
|
|
13
13
|
}
|
|
14
|
-
],
|
|
15
|
-
"SessionEnd": [
|
|
16
|
-
{
|
|
17
|
-
"matcher": "",
|
|
18
|
-
"hooks": [
|
|
19
|
-
{
|
|
20
|
-
"type": "command",
|
|
21
|
-
"command": "node \"$CLAUDE_PROJECT_DIR/.claude/hooks/session-reflect.mjs\"",
|
|
22
|
-
"async": true
|
|
23
|
-
}
|
|
24
|
-
]
|
|
25
|
-
}
|
|
26
|
-
],
|
|
27
|
-
"UserPromptSubmit": [
|
|
28
|
-
{
|
|
29
|
-
"matcher": "",
|
|
30
|
-
"hooks": [
|
|
31
|
-
{
|
|
32
|
-
"type": "command",
|
|
33
|
-
"command": "node \"$CLAUDE_PROJECT_DIR/.claude/hooks/prompt-recall.mjs\""
|
|
34
|
-
}
|
|
35
|
-
]
|
|
36
|
-
}
|
|
37
14
|
]
|
|
38
15
|
}
|
|
39
16
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Testing
|
|
2
|
+
|
|
3
|
+
Framework choice is never ad hoc and never the user's problem mid-task: detect the stack, use its row. If the repo already has a runner, that runner wins — never introduce a second framework beside it.
|
|
4
|
+
|
|
5
|
+
## Frameworks by stack
|
|
6
|
+
|
|
7
|
+
No alternatives. Just use these.
|
|
8
|
+
|
|
9
|
+
| Stack | Unit / integration | Component | E2E | HTTP mocking | Don't use |
|
|
10
|
+
| --- | --- | --- | --- | --- | --- |
|
|
11
|
+
| Node + Vite / React (web) | vitest | @testing-library/react (+ @testing-library/user-event, happy-dom) | @playwright/test | msw | jest, mocha, jasmine, cypress, enzyme |
|
|
12
|
+
| Express APIs | vitest | — | supertest against the app instance | msw (outbound calls) | jest, chai-http |
|
|
13
|
+
| React Native / Expo | jest via the jest-expo preset | @testing-library/react-native | maestro | msw | detox, enzyme |
|
|
14
|
+
| Cloudflare Workers | vitest + @cloudflare/vitest-pool-workers | — | @playwright/test against `wrangler dev` | msw | jest |
|
|
15
|
+
| Rust | `cargo test` (built-in) | — | — | — | — |
|
|
16
|
+
|
|
17
|
+
All npm packages at `latest`. Fake data comes from `@ngneat/falso` (the repo standard — never faker/chance).
|
|
18
|
+
|
|
19
|
+
## Conventions
|
|
20
|
+
|
|
21
|
+
- **Suite, not scripts.** Tests live in the canonical test tree (`tests/`, mirroring `src/`), named `<subject>.test.ts`. Shared fixtures, factories, and helpers live in `tests/helpers/`. The harness `CLAUDE.md` Tests guardrail carries the full suite-first policy; this rule owns only the technology choices.
|
|
22
|
+
- **Wire the canonical command.** `"test"` in package.json runs the whole unit suite (`vitest run`); e2e runs under `"test:e2e"`. A repo where `pnpm test`/`npm test` doesn't run the suite is misconfigured.
|
|
23
|
+
- **Unit and E2E trees stay separate.** Vitest/Jest suites in `tests/`; Playwright/Maestro suites in `e2e/` with their own config — never mixed into the unit runner's glob.
|
|
24
|
+
- **No test doubles for what you own.** Prefer real instances — in-memory SQLite for drizzle, the actual Express app via supertest — over mocks; mock only true externals (network via msw, time via the runner's fake timers).
|
|
25
|
+
- **Determinism.** No real network, no real time, no shared mutable state between tests; every test must pass alone and in any order.
|
|
@@ -102,7 +102,7 @@ The complexity dial sets _defaults_, not a cage: any lazy pillar materializes mi
|
|
|
102
102
|
|
|
103
103
|
The background reconciler that replaces ceremony with consistency. **One sync in flight at a time; queue at most one behind it.**
|
|
104
104
|
|
|
105
|
-
**When:** after a distillation batch lands substantive pillar writes (at the turn break, not mid-sentence); mandatorily on entering converge and at `stop`; on demand. At **low** complexity, run it inline yourself; at **medium+**, dispatch a background `general-purpose` agent (read/write access to the session folder only
|
|
105
|
+
**When:** after a distillation batch lands substantive pillar writes (at the turn break, not mid-sentence); mandatorily on entering converge and at `stop`; on demand. At **low** complexity, run it inline yourself; at **medium+**, dispatch a background `general-purpose` agent **on Opus** (`model: "opus"` — pillar reconciliation is quality-critical, so never a smaller model; and never the main-loop frontier model, whose session budget belongs to the conversation), with read/write access to the session folder only. Exception at any complexity: the `stop` sync's self-containment pass always dispatches the context-free agent — an inline reader with full conversational context cannot cold-read, because it already knows every undefined term.
|
|
106
106
|
|
|
107
107
|
**The filing checklist — before every dispatch.** The sync agent cannot see the conversation, so the orchestrator runs the transcript-side half itself, immediately before dispatching: list your substantive contributions since the last sync — analyses, diagnoses, recommendations with reasoning, definitions, rejections — and file any that aren't on disk (evidence note, decision rationale, glossary line, rejected entry). Only then dispatch. A sync dispatched over unfiled substance audits an incomplete record and stamps it green.
|
|
108
108
|
|