Skip to content

docs: agent guidance distilled from review feedback - #156

Open
natemoo-re wants to merge 2 commits into
mainfrom
docs/review-patterns
Open

natemoo-re wants to merge 2 commits into
mainfrom
docs/review-patterns

Conversation

@natemoo-re

Copy link
Copy Markdown
Member
  • Went through review feedback on every open and merged PR and pulled out the things that keep coming up
  • The firm rules (spec wording, specs never out of date, picture-style layout tests, string-literal API values, state kept on the native side, no made-up defaults) go straight into AGENTS.md so every agent session sees them
  • Everything else (judgment calls about API shape, C/WASM pitfalls, test coverage, benchmarks, PR hygiene) lives in a new docs/review-patterns.md, each item linked to the PR where it came up
  • AGENTS.md now says to check that guide and run deno task fmt before opening a PR
  • Docs only, no code changes, so no changeset

Synthesizes recurring review feedback across merged and open PRs into
agent-facing guidance (specs, native-first placement, API shape, C/WASM
correctness, tests, performance, hygiene), each rule linked to the PR
where it came up. AGENTS.md points at it as a pre-PR check.
Spec wording, spec/code sync, visual layout tests, string-literal API values, native-owned state, and no fabricated defaults are invariants rather than judgment calls, so they move into AGENTS.md where every session loads them. review-patterns.md keeps the heuristics.
@bombshell-cooper

Copy link
Copy Markdown
Contributor

No changeset needed

This pull request is classified as no_release_impact: no published package

@pkg-pr-new

pkg-pr-new Bot commented Oct 16, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@bomb.sh/tty@156

commit: ce58dda

@natemoo-re
natemoo-re marked this pull request as ready for review October 16, 2026 23:20
@natemoo-re
natemoo-re requested a review from cowboyd October 18, 2026 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant