docs: add COHERENCE.md as a required doc, audited against the codebase
COHERENCE.md states the product-coherence thesis (pmacs should be immediately excellent, progressively understandable, completely inspectable, and ultimately replaceable) and, per-section, the audited ground truth of how the codebase measures against it: a scorecard across 19 concerns, the golden-journey verdict table (breaks at "open a real project" -- `pmacs .` exits 1), the six hardcoded key-interception shadows with no transient-keymap mechanism to migrate them to, the discoverability substrate-without-surface gap, the package/worker identity gap, and three cross-cutting patterns (substrate without surface, the silence asymmetry, per-arc coherence debt) that explain most of the individual findings. CLAUDE.md and AGENTS.md now list it as required reading alongside agent-handoff.md and active-work.md, and ask new framing docs to state their coherence impact. No runtime code changes.
This commit is contained in:
parent
0827dd1416
commit
066b8652b8
16
AGENTS.md
16
AGENTS.md
|
|
@ -1,11 +1,15 @@
|
|||
# pmacs agent instructions
|
||||
|
||||
**Start here: read `docs/agent-handoff.md`, then
|
||||
**Start here: read `docs/agent-handoff.md`, then `COHERENCE.md`, then
|
||||
`docs/active-work.md`, before taking on any work.** The handoff carries
|
||||
durable project state, working method, substrate invariants, and the
|
||||
standing backlog. The active-work ledger carries volatile branches,
|
||||
standing backlog. `COHERENCE.md` carries the product-coherence thesis
|
||||
and its audited ground truth (scorecard, per-concern gaps, priority
|
||||
order) — it is the standard new work gets evaluated against, not just a
|
||||
backlog item; read it before framing anything and cite the section a
|
||||
framing doc serves. The active-work ledger carries volatile branches,
|
||||
checkpoints, verification, and exact cross-machine recovery commands.
|
||||
Keep both updated according to their own update protocols.
|
||||
Keep all three updated according to their own update protocols.
|
||||
|
||||
Always true, independent of the handoff:
|
||||
|
||||
|
|
@ -14,7 +18,11 @@ Always true, independent of the handoff:
|
|||
(`pmacs-protocol`). `#![forbid(unsafe_code)]`.
|
||||
- Workflow: framing doc in `docs/` -> user approval -> branch -> implement
|
||||
-> full gate suite -> PR -> user review rounds -> user says when to
|
||||
merge. Never merge unprompted. One feature, one branch, one PR.
|
||||
merge. Never merge unprompted. One feature, one branch, one PR. A
|
||||
framing doc for coherence-affecting work should state its coherence
|
||||
impact (journey steps touched, interaction islands added, config
|
||||
registry adoption, background-work attribution) per `COHERENCE.md`
|
||||
§20.
|
||||
- Gates before any PR: `cargo fmt --check`; `cargo clippy --workspace
|
||||
--all-targets -- -D warnings` (as its own step); `cargo test --lib`;
|
||||
`cargo test --lib --features crdt`; the touched acceptance suites;
|
||||
|
|
|
|||
16
CLAUDE.md
16
CLAUDE.md
|
|
@ -1,11 +1,15 @@
|
|||
# pmacs agent instructions
|
||||
|
||||
**Start here: read `docs/agent-handoff.md`, then
|
||||
**Start here: read `docs/agent-handoff.md`, then `COHERENCE.md`, then
|
||||
`docs/active-work.md`, before taking on any work.** The handoff carries
|
||||
durable project state, working method, substrate invariants, and the
|
||||
standing backlog. The active-work ledger carries volatile branches,
|
||||
standing backlog. `COHERENCE.md` carries the product-coherence thesis
|
||||
and its audited ground truth (scorecard, per-concern gaps, priority
|
||||
order) — it is the standard new work gets evaluated against, not just a
|
||||
backlog item; read it before framing anything and cite the section a
|
||||
framing doc serves. The active-work ledger carries volatile branches,
|
||||
checkpoints, verification, and exact cross-machine recovery commands.
|
||||
Keep both updated according to their own update protocols.
|
||||
Keep all three updated according to their own update protocols.
|
||||
|
||||
Always true, independent of the handoff:
|
||||
|
||||
|
|
@ -14,7 +18,11 @@ Always true, independent of the handoff:
|
|||
(`pmacs-protocol`). `#![forbid(unsafe_code)]`.
|
||||
- Workflow: framing doc in `docs/` -> user approval -> branch -> implement
|
||||
-> full gate suite -> PR -> user review rounds -> user says when to
|
||||
merge. Never merge unprompted. One feature, one branch, one PR.
|
||||
merge. Never merge unprompted. One feature, one branch, one PR. A
|
||||
framing doc for coherence-affecting work should state its coherence
|
||||
impact (journey steps touched, interaction islands added, config
|
||||
registry adoption, background-work attribution) per `COHERENCE.md`
|
||||
§20.
|
||||
- Gates before any PR: `cargo fmt --check`; `cargo clippy --workspace
|
||||
--all-targets -- -D warnings` (as its own step); `cargo test --lib`;
|
||||
`cargo test --lib --features crdt`; the touched acceptance suites;
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue