chore(contract): memory-v2-minors-docs plan r2 + contract

This commit is contained in:
bchanot committed 2026-11-01 12:08:48 +01:00
1 parent dfbc8a7e4e
commit f83fcedaf6
2 files changed
+96

No files matched your search

@@ -0,0 +1,34 @@
# CONTRACT — memory-v2-minors-docs
## REQUEST (verbatim — IMMUTABLE)
Phase 4a parked minors, doc half (5 doc files, no code): (1) lib/capitalize-commit.md § WRITE: with `-C <project root>`, memory.sh does `cd` before reading `--body-file`, so a relative body-file path resolves against the project root, not the caller's cwd; say to pass an absolute `--body-file` with `-C`. (2) skills/tour/SKILL.md, skills/deploy/SKILL.md, skills/audit-delta/SKILL.md: their "offer to capitalize" sentence names the registries but not the write path; add the pointer "per `lib/capitalize-commit.md` § WRITE" like feat/bugfix/hotfix/capitalize do. (3) templates/memory/evals.md: add the "Later status" line that blockers.md and decisions.md templates carry (`bash ~/.claude/lib/memory.sh status EVAL-NNN "correct …"` / `"deprecate, see BDR-NNN"`). The rc 6 text in capitalize-commit.md was already updated by the code half's doc sync (18e6370).
## CLARIFICATIONS
- Plan r2: `.claude/tasks/plans/2026-11-01-memory-v2-minors-docs-1130.md`. Wording closed there; the `-C` sentence sits in the § WRITE intro (covers add, status, journal), the Entry bullet's own `-C` sentence is removed; the executor changes nothing else in the five files.
- 2026-11-01 user [gated]: evals `Later status` example = `deprecate, see BDR-NNN`; the pointer sentence is the same short form in all three skills: "Approved entries per `lib/capitalize-commit.md` § WRITE."
- Code half shipped as feature/memory-v2-minors → develop c92381e; this contract is the doc half only.
## ACCEPTANCE CRITERIA
1. lib/capitalize-commit.md § WRITE says, once for every verb, that `-C` `cd`s first and the `--body-file` path is absolute.
CHECK: cd /home/bchanot/Documents/claude && sed -n '/^## WRITE/,/^## /p' lib/capitalize-commit.md | tr -s ' \n' ' ' | grep -q 'body-file. an absolute path' && [ "$(sed -n '/^## WRITE/,/^## /p' lib/capitalize-commit.md | grep -c 'when the cwd is not the project root')" = 1 ] && echo WRITE-OK
EXPECT: WRITE-OK
EVIDENCE: MET exit=0 marker-found :: WRITE-OK
2. The capitalize offer in skills/tour, skills/deploy and skills/audit-delta points at `lib/capitalize-commit.md` § WRITE.
CHECK: cd /home/bchanot/Documents/claude && for s in tour deploy audit-delta; do grep -q 'lib/capitalize-commit.md` § WRITE' skills/$s/SKILL.md || exit 1; done && echo POINTER-OK
EXPECT: POINTER-OK
EVIDENCE: MET exit=0 marker-found :: POINTER-OK
3. templates/memory/evals.md carries a `Later status:` line naming `memory.sh status EVAL-NNN`, inside the template comment like blockers.md and decisions.md.
CHECK: cd /home/bchanot/Documents/claude && grep -q 'Later status: `bash ~/.claude/lib/memory.sh status EVAL-NNN' templates/memory/evals.md && awk '/^<!--/{c=1} /^-->/{c=0} /Later status/{print c}' templates/memory/evals.md | grep -q 1 && echo EVALS-OK
EXPECT: EVALS-OK
EVIDENCE: MET exit=0 marker-found :: EVALS-OK
4. `make test` green (doctrine-citers census, project-rules); the diff vs develop adds no line over 80 bytes in lib/capitalize-commit.md (templates are not held to 80: decisions.md:32 is 84), and touches only the five files.
CHECK: cd /home/bchanot/Documents/claude && t=$(make test 2>&1) && printf '%s\n' "$t" | grep -q 'all suites green' && [ "$(git diff develop -- lib/capitalize-commit.md | grep '^+' | grep -v '^+++' | LC_ALL=C awk 'length($0) > 81' | wc -l)" = 0 ] && [ "$(git diff develop --name-only -- . ':!settings.json' ':!.claude' | sort | tr '\n' ' ')" = "lib/capitalize-commit.md skills/audit-delta/SKILL.md skills/deploy/SKILL.md skills/tour/SKILL.md templates/memory/evals.md " ] && echo DOCS-LINT-OK
EXPECT: DOCS-LINT-OK
EVIDENCE: MET exit=0 marker-found :: DOCS-LINT-OK
## FILE SCOPE
- lib/capitalize-commit.md
- skills/tour/SKILL.md
- skills/deploy/SKILL.md
- skills/audit-delta/SKILL.md
- templates/memory/evals.md
@@ -0,0 +1,62 @@
# /feat memory-v2-minors-docs — PLAN r2
r2 2026-11-01 after 3 lenses: simplicity FATAL(2), correctness FATAL(1),
robustness FATAL(1). One shared BLOCKER (the 86-byte evals line vs criterion
4) and one MAJOR (the `-C` sentence must cover status/journal too) folded;
all MINORs folded. No deferral. The approach (same five files, same edits)
did not change, so no second pass.
FEAT: phase 4a parked minors, doc half — 5 doc files, wording only. Code half
shipped (develop c92381e). No logic, no test code: the oracles are greps.
User picks 2026-11-01 (gated): evals example word = `deprecate, see
BDR-NNN`; the same short pointer sentence in all three skills.
## Plan
- [ ] lib/capitalize-commit.md § WRITE intro (lines 34-35, "Registry entries
and journal lines are written only by `lib/memory.sh`, never by Edit or
append; there is no `## Index` to update."): append one sentence, wrapped
at 80: "Every verb takes `-C <project root>` when the cwd is not the
project root; it `cd`s first, so give `--body-file` an absolute path."
Then DELETE the Entry bullet's last sentence "`-C` when the cwd is not
the project root." (line 42) so `-C` is stated once, for add, status
and journal alike. Keep the bullet's wrap.
- [ ] skills/tour/SKILL.md: after line 277 ("repo's nor any target
project's."), add ONE new line "Approved entries per
`lib/capitalize-commit.md` § WRITE." No reflow of the paragraph; the
citation stays on one line.
- [ ] skills/deploy/SKILL.md step 7 (lines 449-450): after "gated, never
silent." append " Approved entries per `lib/capitalize-commit.md` §
WRITE." — put it on a NEW continuation line with the item's 3-space
indent, citation on one line; no reflow of the existing lines.
- [ ] skills/audit-delta/SKILL.md: after line 251 ("`evals.md`. Behind
approval, never silent."), add ONE new line "Approved entries per
`lib/capitalize-commit.md` § WRITE." No reflow.
- [ ] templates/memory/evals.md: insert ONE line between the existing blank
line (evals.md:30) and `-->` (evals.md:31), no new blank line:
Later status: `bash ~/.claude/lib/memory.sh status EVAL-NNN "deprecate, see BDR-NNN"`.
That is the shape of blockers.md:28-30 and decisions.md:31-33 (blank,
`Later status:`, `-->`). The line is 86 bytes: templates are not held
to 80 (decisions.md:32 is 84; evals.md:9,13,16,17 already exceed it),
and criterion 4's width check covers lib/capitalize-commit.md only.
`deprecate` is a status word (`_MEM_WORDS`) that names a successor; it
does not close an entry (`memory_closed` = resolved|superseded|
deprecated), which is fine for an eval.
- [ ] No test file: criteria 1-4 are grep/awk oracles run by gates.sh; the
executor runs `make test` (doctrine-citers census: 8 citers already
use the identical string `lib/capitalize-commit.md` § WRITE).
## Edge cases
- The three skills keep their CLAUDE.md gate sentence; the new line names
the write path only.
- `~/.claude/lib/memory.sh` is a `.sh` path: the census never extracts it.
- Nothing parses the template comment block (init-project, capitalize and
onboarder `cp -n` it; memory.sh reads only the frontmatter).
## Parked (TODO line, outside FILE SCOPE)
- MIGRATION.md:209 shows `memory.sh -C <project> add … --body-file …` with
no absolute-path note: same trap, next doc pass.
## Disposition
Honors BDR-129 (single writer: every doc points at the one § WRITE entry
point) and BDR-022 (doc-commit never touches `.claude/`: FILE SCOPE is outside
it). No in-force LRN constrains a wording change.