Skip to content

docs(agents): add first-pass review-readiness checklist (mined from ~300 PRs)#4475

Open
vibegui wants to merge 1 commit into
mainfrom
docs/agents-first-pass-checklist
Open

docs(agents): add first-pass review-readiness checklist (mined from ~300 PRs)#4475
vibegui wants to merge 1 commit into
mainfrom
docs/agents-first-pass-checklist

Conversation

@vibegui

@vibegui vibegui commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Refactors AGENTS.md (the file CLAUDE.md symlinks to) with a new "Ship it review-ready — the first-pass checklist" section, derived from analyzing what actually changes between a PR's first proposal and its merged state.

How this was built

Mined the last ~300 merged PRs, looking specifically at the diff between the first commit and the merged result — the "review/hardening work." Findings, using the graph as a map of where churn concentrates (decopilot, sandbox, chat, sections-editor — the same hotspots the audit flagged):

The hardening pass adds the same 9 categories every time. The checklist encodes them so a coding agent does them on the first pass, each citing the PR it came from:

  1. Handle the variants, not the happy path (empty/null/oversized/every schema shape)
  2. Scope by tenant & permission; gate the complete payload; no key/id collisions
  3. Concurrency — no silent data loss (non-retriable side effects, claim fences at dispatch, coalesce fire-and-forget)
  4. Test each behavior in the right tier — invert bug-encoding tests, grep all tiers, real-Postgres for storage, provider-independent e2e
  5. Leave no dead code (narrow exports, delete orphans, run knip)
  6. Complete the lifecycle & reset state (create+update+delete together, idempotent clear-then-write)
  7. Make risky/infra changes reversible & bounded (own default-off flag, TTL+cap GC, health-gated publish, git-exclude, idle reaper over fixed timeouts)
  8. Validate external input; don't over-engineer (schema-driven > runtime inference; DS tokens; fmt)
  9. Keep type-safety at compile time (no as-cast on unions; noUncheckedIndexedAccess)

It's cross-linked with the existing "Common Gotchas" list (which stays as the always-load-bearing set).

Testing

Docs-only change to AGENTS.md. No code touched.

Notes

🤖 Generated with Claude Code


Summary by cubic

Adds a “Ship it review‑ready” first‑pass checklist to AGENTS.md to help authors ship PRs that need fewer hardening passes. The checklist distills nine recurring fix areas from ~300 merged PRs and links to real examples.

  • New Features
    • 9-point checklist covering: edge-case/variant handling; tenant/permission scoping; concurrency/idempotency; test-per-fix in the right tier; dead code cleanup; lifecycle symmetry/state reset; reversible infra via flags/GC; input validation/DS tokens; compile-time type safety.
    • Cross-linked with “Common Gotchas”. Docs-only; CLAUDE.md (symlink) reflects the change.

Written for commit e3fb43a. Summary will update on new commits.

Review in cubic

…TS.md

Mined ~300 merged PRs for the delta between the first PR proposal and the
work added before merge. The dominant shape: a first draft ships the happy
path, then a hardening pass (often a different engineer who takes over the
branch and merges — the vibecoder→engineer handoff) adds the same categories
every time. Encoded those 9 categories as an actionable first-pass checklist,
each citing a real PR (#4008, #4230, #4365, #4409, #4426, #4445, #4357, #4355,
#4449, #4350, #4373, #4416, #4446, #4461, #4134, #4469).

Covers: variant/edge-case handling, tenant/permission scoping, concurrency &
silent-data-loss, test-per-fix + invert-bug-tests + real-PG, dead-code/knip,
lifecycle symmetry + state reset, kill-switch/GC/git-exclude for risky infra,
input validation vs over-engineering, compile-time type-safety.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vibegui vibegui added the documentation Improvements or additions to documentation label Jul 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant