docs: clarify existing implementation ADR guidance #116
Loading…
Reference in a new issue
No description provided.
Delete branch "docs/clarify-implementation-adr-guidance"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Clarifies the existing ADR guidance identified in #115 by explicitly passing the code-comment rule to the implementer and referring to the drop's ADR without repeating its format limit.
Review
01M4473NADPV6WDREV56H4QW3G— headadd0b1136a7f4f4b840c2a2f3e5bb107a067e07cReview — j4k-oss/agent-skills @
df31a6e1ccScope: diff against base tree
8d139933be25Status: dispatched — coverage complete (5/5 slots terminal)
Facts: current review-wide projection
Computed under:
Findings (1)
medium — Verification section copies the shared skill’s check set
01M4487FJJ04VF82SGSZ76D0QKskills/reengineer-program/references/implementation.md(snippet)01M4488HASYAGV6Y4GYDTF79W9· valid: The exact grounded section counts and lists the three verification categories. The reviewer names skills/reengineering/SKILL.md as the defining source and lists its corresponding Retained, Dropped, and Replaced or added promises; the local Unchanged category maps to Retained. No member differs now, but the second complete list can drift when the shared checks change. The prior matching-anchor verdicts identify no concrete safeguard. Point to the shared verification checks and preserve the local snapshot, surviving-test, rejection, and confirmed-design methods without a copied count or set.Other claims
01M4485X69VH4MM9EZ4F4PJYG1medium — Implementation reference repeats the parent skill's code-comment exclusionsCoverage
Coverage pass: 01M447YZBGKAJ1N616FWQZYH9E
Accounting: complete
Slot health: healthy
@ -17,3 +17,3 @@Dispatch a fresh implementation sub-agent into a worktree with the old implementation for the chosen scope removed, along with tests of its internals and tests asserting promises the accepted design replaces. Retain build configuration, schemas, fixtures, tests exercising kept surfaces from outside, and exact kept-surface signatures.Give the implementer the confirmed design, `CONTEXT.md`, the boundary ADR, binding ADRs in scope, and kept-surface signatures as authority. It may read old code from git only when that is the sole record of an existing external dependency left unspecified by those inputs — a consumer's byte format or stored-data layout, for example. Require it to report each such read and the question it answered. Rationale stays in ADRs, without ADR citations or restatements in code comments.Give the implementer the confirmed design, `CONTEXT.md`, the boundary ADR, binding ADRs in scope, and kept-surface signatures as authority. It may read old code from git only when that is the sole record of an existing external dependency left unspecified by those inputs — a consumer's byte format or stored-data layout, for example. Require it to report each such read and the question it answered. Require it to keep rationale in ADRs, without ADR citations or restatements in code comments.medium — Implementer brief tells the sub-agent to "keep rationale in ADRs", which reads as permission to write ADRs
lens
writing-quality· armdefault· tally 1 valid / 0 invalid / 0 uncertainclaim
01M446R13V1FQTH68VWQ2Y9SHNof review01M446KNAEBD8TQNYHWDSGN8TBFixed in
add0b11: the implementer is only required to leave ADR rationale out of code comments, with no ADR citations or restatements; the brief no longer assigns keeping rationale in ADRs to it.The summary-only checklist-count claim
01M446R1NDK40C2THD8T3XNMWRis already addressed by merged #115 (f8473dd); that independent change composes with this PR. Tracked the kept-surface example claim01M446RFYQARJXD9YYVSFAXS4Hin #117; its clarification is not claimed fixed in #116 by the unmerged child.Tracked the summary-only shared-check-category claim
01M4487FJJ04VF82SGSZ76D0QKin #118, preserving the implementation-specific verification methods. It is not claimed fixed in #116 by the unmerged follow-up.The unadjudicated medium code-comment-exclusions claim
01M4485X69VH4MM9EZ4F4PJYG1remains unconfirmed: its body omits the defining source paths and explicitly leaves the future implementer's access to the parent rule unverified. This PR's scoped outcome is to pass that existing prohibition to a fresh implementer. What evidence establishes that the implementer receives or reads the parent rule without the explicit brief instruction? This claim's service adjudication remains outstanding; #116 is not declared complete or merged.Closing out this PR without another review round. The inline finding
01M446R13V1FQTH68VWQ2Y9SHNwas fixed inadd0b11, and the other claims are tracked in #117 and #118 (merged separately). The remaining unadjudicated claim01M4485X69VH4MM9EZ4F4PJYG1is a non-blocking wording-duplication concern; it names no defect in the promised behavior and the question above stayed unanswered, so it is left unconfirmed and not carried into a follow-up. The change is two lines of guidance, checks other than the non-required Review job pass, and the branch merges cleanly into current main.