guidelines: verify the invocation contract + "compiles ≠ works" (§7, §4)#17
Merged
Conversation
Two checks that close a common gap: verifying a change's *behavior* while assuming its *invocation*. A feature can shell out to a command with flags lifted from the wrong docs section, or ship behind a self-written "deployed but never exercised" caveat, and still pass a green build — a wrong flag, dead endpoint, or mis-set env var is invisible to compile/typecheck/deploy. - §7: verify the invocation contract (exact flags/params/env, arg order) against the primary source — the command's own option definition, the API schema — not prose docs or a sibling example. The mundane call detail is most likely wrong and least likely checked, precisely because it feels beneath verifying. - §4: "compiles/typechecks/deploys" is not "it works" — run it once against the real target; a self-flagged "unverified" caveat on a load-bearing path is a gate, not a footnote, and the bar scales with blast radius. Regenerated fan-out copies via scripts/build-rules.js (--check clean).
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
1 participant
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.
Two checks that close a common gap: verifying a change's behavior while
assuming its invocation. A feature can shell out to a command with flags lifted
from the wrong docs section, or ship behind a self-written "deployed but never
exercised" caveat, and still pass a green build — a wrong flag, dead endpoint, or
mis-set env var is invisible to compile/typecheck/deploy.
the primary source — the command's own option definition, the API schema — not
prose docs or a sibling example. The mundane call detail is most likely wrong
and least likely checked, precisely because it feels beneath verifying.
real target; a self-flagged "unverified" caveat on a load-bearing path is a
gate, not a footnote, and the bar scales with blast radius.
Regenerated fan-out copies via scripts/build-rules.js (--check clean).