timothy
fba5233caf
168 records -> docs/decisions/records/<area>/<topic>.md (163 active, 23 dirs) and docs/decisions/archive/<area>/<topic>.md (5 archived). The filename IS the key, so one-active-record-per-key becomes a filesystem property rather than a validator check, and supersession becomes a `git mv`. WHY: the monolith was a concurrency problem before an aesthetic one. A 3,900-line append target made parallel sessions collide -- PR #605 and PR #614 both hit append-vs-append conflicts during routine rebases, and hand-resolving those inside the corpus is exactly the operation the rationale-rewrite guard exists to police. HOW IT IS VERIFIED: a ~170-file diff cannot be meaningfully read, so correctness does not rest on reading it. The parser was taught BOTH formats first, so the body-diff guard parses the old form at the merge-base and the new form at head -- the migration validates itself, no bypass. The proof is a field-level equivalence harness: 168 records before and after, zero lost, zero gained, zero field mismatches, zero rationale bodies differing. Reviewers should scrutinise the harness; it is the actual evidence. What measuring caught that reading would not have: - ~500 lines sit OUTSIDE any record -- decisions.md's lifecycle schema and each topic file's preamble, mostly the only copy. Source files are kept and stripped, never deleted. They also cannot be filed per-area: topic files hold several areas and 4 of 23 areas span several files. - Archive discovery was a non-recursive glob; after the split it found ZERO archived records, surfacing as four bogus "supersedes points to unknown key" errors rather than an obvious failure. - ~32 live docs point into the corpus BY DATE, which the split dangles. Each stripped file now ends with a generated "Records formerly in this file" index, which also rescues the identical breadcrumbs in old issue comments. - decisions.md's "In this file:" list was 97 same-file anchor bullets that the split makes WRONG, not merely stale. Dropped; the generated index replaces them with links that resolve. The equivalence harness now runs against a checked-in FIXTURE, not the live corpus. The earlier version migrated the real tree, which made it a one-shot: the moment the migration landed there was nothing left to move and the tests failed for reasons unrelated to the code. A fixture keeps them testing the SCRIPT rather than the repo's current state. Keys preserved verbatim, warts included: `sched` (12) and `scheduling` (1) remain two directories for one concept. Renaming a key is not a move -- it changes identity, breaks the equivalence proof, and invalidates MemPalace's per-key drawers. Taxonomy normalisation is separate work. refs #610
3.1 KiB
key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
| key | title | status | since | supersedes | superseded-by | rule | signals | mechanics |
|---|---|---|---|---|---|---|---|---|
| release.format-as-you-touch-rebase | 2026-07-12 — Formatting-as-you-touch, enforced; rebase-not-merge for PR branches (#311 H11 + format CI) | active | 2026-07-12 | none | none | A blocking `format` CI job runs `dotnet format --verify-no-changes` scoped only to the PR's changed `.cs` files (never the legacy BOM backlog), and a PR branch must be kept current by rebasing on `origin/main` (never merging main in), enforced by `.husky/pre-push` → `prepush-rebase-check.sh`. | format-as-you-touch, rebase not merge, BOM backlog · paths: `.husky/pre-push`, `.claude/hooks/prepush-rebase-check.sh` · issues: #311 (H11), #309, #310, #269, #312 | `docs/contributing.md` §7; `.claude/hooks/prepush-rebase-check.sh`; `npm run check:api` |
Two coupled process decisions, prompted when a stale docs branch merged main in, dragged ~17
legacy-BOM .cs files it never touched into the merge commit, and the pre-commit dotnet format
hook then blocked on code that wasn't the author's (#309 session; the BOM backlog is #310).
1. Formatting-as-you-touch is the standing rule, and it is now enforced (not just prose). ~2500
of ~3900 .cs files carry a legacy UTF-8 BOM that violates .editorconfig's charset=utf-8. We do
not mass-reformat (a repo-wide normalization stays an unmade, separate decision). Instead, a file
you modify for other work must be normalized (dotnet format, incl. BOM strip) in that same PR.
Enforcement — previously only the --no-verify-bypassable pre-commit hook, which is how #269 landed 17
BOM files (CI never checked charset):
- a blocking
formatCI job runsdotnet format --verify-no-changesscoped to the PR's changed.cs(vs the merge-base) — so it demands conformance only of files the PR touched, never the untouched legacy 2500; a.cs-free PR skips the expensive steps and passes (always reports a status, safe as a required check). This closes the "CI never verifies charset/format" gap. docs/contributing.md§7 documents the rule.
2. Keep a PR branch current by REBASING on origin/main, never merging main in (H11). A merge
commit pulls in every file main changed — including files the author never touched — which then trip
the format hook/CI on code that isn't theirs; rebasing keeps the diff to exactly what changed.
Enforced by .claude/hooks/prepush-rebase-check.sh wired into .husky/pre-push: a push from a branch
that is behind origin/main (origin/main not an ancestor of HEAD) is blocked with
git rebase origin/main guidance. Fail-open (offline / no origin/main / not a repo → allow, since a
git hook has no "ask"); deliberate escape ETV_SKIP_REBASE_CHECK=1. This supersedes the old lore
guidance to "merge main into your PR branch." (After a rebase that conflicts in generated artifacts —
v1.json/v1.d.ts/endpoint-index — regenerate, don't hand-resolve; npm run check:api guards.)
Rationale, as with the whole hook program: make the process rule a derivation/hook, not prose to remember (#303 methodology review). Tracked: #311; sibling #312 (H12 issue-qualification audit).