Fix AGENTS.md: unenforceable rule and unverified deployment claim - #290
Merged
Conversation
- exactOptionalPropertyTypes forces the ...(x !== undefined ? {k:x} : {})
idiom to omit an optional key; the old "never assembled by spreading"
rule contradicted this and was ignored in 90+ files. Carve out the
exception instead of stating a rule the compiler forbids.
- "Deployment is explicit via Pulumi (Railway)" isn't backed by anything
in this repo (no pulumi dependency, no infra directory) and
IMPLEMENTATION.md itself lists where that config lives as an open
question. Point at IMPLEMENTATION.md instead of restating an unsettled
claim here.
- Add the two lessons that cost real time: scripts/checks/* are heuristics
over source text and can false-positive, and CI green isn't proof the UI
works (that's what scripts/e2e/browser/walkthrough.ts is for).
- Make explicit that only "Conventions a check enforces" is actually
enforced; everything else is prose that can drift.
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.
Summary
exactOptionalPropertyTypes: true, which requires...(x !== undefined ? {k:x} : {})to omit an optional key. 90+ files already use this idiom (e.g.apps/sidecar/src/workflow-host-wiring/index.ts, which carries a comment apologizing for it). Carved out the exception instead of stating a rule the compiler forbids.pulumidependency, no infra directory — and IMPLEMENTATION.md's own Open Questions section says where that config lives isn't established. Replaced the restated claim with a pointer to IMPLEMENTATION.md.scripts/checks/*are heuristics over source text and can false-positive (a check failure is a claim to verify, not a verdict), and CI green isn't proof the UI works — that's whatscripts/e2e/browser/walkthrough.tsis for.docs/DECISIONS.mddoes not exist in this repo (it shouldn't — owner rulings belong in Linear) and confirmed every doc-map link still resolves.Follow-up not done here: IMPLEMENTATION.md itself still states Pulumi/Railway deployment as fact in its Deployment section while flagging the config location as an open question two sections later — worth reconciling separately.
Test plan
bunx prettier --check AGENTS.mdpassesCL-6584