Skip to content

Names the dated-note amendment form - #220

Merged
johnnyt merged 2 commits into
mainfrom
px-x5s-adr-note-form
Sep 5, 2026
Merged

Names the dated-note amendment form#220
johnnyt merged 2 commits into
mainfrom
px-x5s-adr-note-form

Conversation

@johnnyt

@johnnyt johnnyt commented Sep 5, 2026

Copy link
Copy Markdown
Member

Residue from campaign 030 (PR #217's direction review, findings 1 and 2),
routed to px-x5s. Docs-only; two records, both amended by addition.

What changed

docs/adr/README.md named two amendment forms - a superseding ADR, and
a later ADR replacing consequences in place - and did not name the dated
## Notes form that PR #217 introduced here. A third paragraph names it and
its constraints: appended and never rewritten, one dated subsection per
movement, citing the pull requests and beads that moved the world, zero
removed lines under docs/adr/, and no status line of its own. The README is
the index rather than a decision record, so an in-place edit is the right
shape there.

docs/adr/0017's first Note closes on "The paragraph above stands as the
record of why the exclusion existed", without naming the paragraph - and the
nearest paragraph above that sentence is the Note's own bullet list of pull
requests, not the one meant. A third dated Note names the target: the
paragraph opening "A float is outside contingently, and only until a defect
is fixed.", under "Two exclusions that are not decisions". The Note itself is
left as written, which is what the dated-note form asks for.

Provenance

  • Campaign 031, fill lane D, bead px-x5s. Residue routed by the campaign 030
    conductor under D30-3 from px-dvz / PR Notes that ADR-0017's float exclusion is lifted #217 (989b149).
  • Referent confirmed against 989b149's own commit message, which calls the
    target "the paragraph it supersedes ... the record of why the exclusion
    existed".
  • The sibling-repo sentence was narrowed after direction review pass 1: those
    records (statifier-ui ADR-0014 through ADR-0017, opentelemetry_statifier
    ADR-0002) amend by addition under a ## Notes foot, but none uses the dated
    subsection heading this paragraph defines and two carry undated bullets, so
    the sentence now claims only that much. Verified by reading those files
    read-only; no writes were made to either repo.
  • Scope: only the two files the bead names. No source, test, or changelog
    change; changelog.d/ gets no fragment because nothing user-facing moved.

Verification

  • git diff against the merge base over docs/adr/ shows 28 insertions and
    0 deletions (13 in ADR-0017, 15 in the README after the cure).

  • mix test test/docs_adr_links_test.exs - 7 tests, 0 failures.

  • Full gate not applicable: the kit's carve-out reports "no changes under
    lib/, test/, mix.exs, mix.lock, conformance/". CI runs it regardless.

  • Cure commit 4bba6b1 answers direction review pass 1's single RECORD-PROSE
    finding; a fresh cold re-review follows, scope-frozen.

docs/adr/README.md named two ways to amend a record - a superseding ADR,
and a later ADR replacing consequences in place - but not the dated note
ADR-0017 grew in PR 217. A third paragraph names the form and its
constraints: appended and never rewritten, one dated subsection per
movement, zero removed lines, and no status line of its own.

ADR-0017's first Note closes on "The paragraph above" without naming it,
and the nearest paragraph above the phrase is not the one meant. A third
Note names the target - the float-exclusion paragraph under "Two
exclusions that are not decisions" - rather than editing the Note, which
keeps the record amend-by-addition.

Refs: px-x5s
@codecov

codecov Bot commented Sep 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Direction review pass 1 on PR 220 found the closing sentence overstated
the siblings: statifier-ui's ADR-0014 through ADR-0017 and
opentelemetry_statifier's ADR-0002 do amend by addition under a Notes
foot, but none uses the dated subsection heading this paragraph defines,
and two of them carry undated bullets.

The sentence now claims only what those records do, and says the
paragraph fixes the shape used here rather than there. ADR-0017 in this
repo stays the shape to copy.

Refs: px-x5s
@johnnyt

johnnyt commented Sep 5, 2026

Copy link
Copy Markdown
Member Author

Direction review, pass 1: QUALIFIED, 1 finding (RECORD-PROSE) - the README's sibling-repo attribution overstated the dated-note form. Cured in 4bba6b1. Pass 2 (fresh cold agent, scope-frozen): UNQUALIFIED, 0 findings. Full quality gate green in CI on 4bba6b1; the repo's docs-only carve-out applies locally (no changes under lib/, test/, mix.exs, mix.lock, conformance/). Firewall scan over the diff, commit messages, PR title and body, and the bead text: clean, with a constructed positive control that fired.

@johnnyt
johnnyt merged commit 903c9f8 into main Sep 5, 2026
2 checks passed
@johnnyt
johnnyt deleted the px-x5s-adr-note-form branch September 5, 2026 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant