Names the dated-note amendment form - #220
Merged
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdnamed two amendment forms - a superseding ADR, anda later ADR replacing consequences in place - and did not name the dated
## Notesform that PR #217 introduced here. A third paragraph names it andits 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 isthe 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 therecord 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
conductor under D30-3 from px-dvz / PR Notes that ADR-0017's float exclusion is lifted #217 (989b149).
target "the paragraph it supersedes ... the record of why the exclusion
existed".
records (statifier-ui ADR-0014 through ADR-0017, opentelemetry_statifier
ADR-0002) amend by addition under a
## Notesfoot, but none uses the datedsubsection 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.
change;
changelog.d/gets no fragment because nothing user-facing moved.Verification
git diffagainst the merge base overdocs/adr/shows 28 insertions and0 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.