code-review-checklist
Skill246 starsChanged 5 months agoMITView on GitHub
Review a set of code changes against Sculptor's review categories and produce a markdown findings table. Use when reviewing code (your own or others').
27 other projects use a version of this.
Adopted by
Most recently taken up by
- rajdeepbhattacharyya25-pixel/agents-for-antigravity-their own version, first seen Nov 15, 2026
- pfangueiro/claude-code-agentstheir own version, first seen Nov 8, 2026
- vinayaksaxena1-maker/antigravity-disaster-recoverytheir own version, first seen Oct 20, 2026
- sid-lakhani/agents-configtheir own version, first seen Oct 20, 2026
- listener-He/java-harness-agenttheir own version, first seen Oct 20, 2026
- Arasz/ai-badgertheir own version, first seen Oct 19, 2026
Used with
Projects with it also use intelligent-routing, nextjs-react-expert and 8 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
SKB3002Skillintelligent-routing
Automatic agent selection and intelligent task routing. Analyzes user requests and automatically selects the best specialist agent(s) without requiring explicit user mentions.
Also in 5 projects that use this
SKB3002Skillnextjs-react-expert
React and Next.js performance optimization from Vercel Engineering. Use when building React components, optimizing performance, eliminating waterfalls, reducing bundle size, reviewing code for performance issues, or implementing server/client-side optimizations.
Also in 3 projects that use this
xfstudioSkillrust-pro
Master Rust 1.75+ with modern async patterns, advanced type system
Also in 5 projects that use this
jornalistainclusivoSkilldesign-spec
How to author a DESIGN.md file — the machine-readable design-token + human-rationale format that must exist before any UI is built. YAML front-matter token schema (colors, typography, spacing, rounded, components), type system, token references, and canonical section order.
Also in 3 projects that use this
zzfancitizenSkillverify-changes
Verify code changes do not break the project by running tests, linter checks, and import validation. Use after making any code changes, editing Python files, modifying imports, updating dependencies, or refactoring.
Also in 3 projects that use this
VercelSkillweb-design-guidelines
Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".
Also in 6 projects that use this
Other versions27 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 27
- vudovn/ag-kit★ 8.2ksame name
- vudovn/antigravity-kit★ 8.2ksame name
- xenitV1/Antigravity-Workflows★ 130same name
- tranhieutt/software_development_department★ 71same name
- VoDaiLocz/kilo-kit-mcp★ 27same name
- listener-He/java-harness-agent★ 16same name
- xfstudio/skills★ 9same name
- pfangueiro/claude-code-agents★ 7same name
- SKB3002/agenthub★ 4same name
- Arasz/ai-badger★ 3same name
17 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository23 other files it gives its agents.
- openhost-agent/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- address-commentsSkill
- auto-qa-changesSkill
- auto-qa-iphoneSkill
- batch-claude-runnerSkill
- cut-releaseSkill
- debug-integration-testSkill
- frontend-design-tokensSkill
- manually-qa-branchSkill
- measure-react-rendersSkill
- openhost-frontend-previewSkill
- openhost-sculptorSkill
- post-pr-to-slackSkill
- profile-sculptor-backendSkill
- promote-releaseSkill
- run-integration-testSkill
- storybook-screenshotSkill
- update-help-docsSkill
- update-review-rulesSkill
- update-specsSkill
- write-integration-testSkill
- write-release-notesSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
33 rules. 0 are common, 21 are distinctive, and 12 are very specific to this project.
0
Common
Most of the 14 edited versions we read keep these.
21
Distinctive
This author's own choices. Worth a look.
12
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 27
Read it before reading the diff so the goal is fresh while you're reviewing.
- Very specific: line 31
Run git diff <base>...<head> in the working directory and read the full output.
- Distinctive: line 70
Write each finding as a short paragraph, not as a table row.
- Distinctive: line 104
Do NOT collapse multiple empty categories into a single "no issues" note.
- Distinctive: line 105
Do NOT omit a category section.
- Distinctive: line 106
Do NOT use markdown tables — prose only.
- Distinctive: line 118
After the per-category sections, write a short summary (2–4 bullets):
- Very specific: line 147
No tests skipped/xfail/disabled without justification
- Distinctive: line 148
No flaky patterns introduced (sleeps, real network, time-of-day deps)
- Distinctive: line 154
Non-UI bugs MUST have failing-then-passing test output: If the diff has no UI surface and the MR body's "Before" or "After" slots lack a …
- Distinctive: line 170
No incidental history or defensive justification — strip comments that explain today's bug fix, argue for the code's correctness, or …
- Distinctive: line 174
No restating volatile facts from the surrounding code (a count of subclasses, a list of variants/enum cases, the call sites of a function).
- Distinctive: line 177
No ASCII-art banners or box-drawing section dividers.
- Distinctive: line 179
No editorializing — strip frustration, jokes, hedging-as-mood, and exaggeration, keeping any underlying fact.
- Very specific: line 181
No pointers to throwaway docs, tickets, or plan phases — agent_docs/...
- Very specific: line 184
No real people's names in comments, docstrings, or test strings.
- Very specific: line 189
No bare except: or unconditional except Exception:
- Very specific: line 191
No silently swallowed errors (except: pass etc.)
- Distinctive: line 196
No secrets, tokens, API keys, or credentials in code or configs
- Very specific: line 199
No untrusted input fed to subprocess/eval/SQL/template without sanitization
- Very specific: line 204
No new Any types unless justified
- Distinctive: line 206
No new Pyrefly errors; suppressions justified with a comment
- Very specific: line 217
Required: Read docs/development/review/react.md (generic React rules), docs/development/review/sculptor.md (Sculptor-specific frontend …
- Very specific: line 234
Required: Read docs/development/review/integration_tests.md in full with the Read tool and apply every rule in it.
- Very specific: line 242
All imports at top of file (no inline imports unless # noqa: E402)
- Distinctive: line 244
No nested/inline function definitions (except simple lambdas)
- Distinctive: line 248
No magic numbers — use named constants
- Distinctive: line 249
No mutable default arguments
- Very specific: line 251
Run just ratchets if you suspect any counts changed.
- Distinctive: line 254
Commit messages explain the "why"
- Distinctive: line 256
No unrelated changes mixed in
- Distinctive: line 259
Commit messages and the PR/MR title and description are published to a public repository — review them as permanently, world-readable …
- Distinctive: line 282
Commit Messages and PR Descriptions".
“Common” is measured: kept by at least 6 in 10 of the 14 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Code Review Checklist
Review a set of code changes against the categories below and produce a markdown findings table.
Inputs
- Working directory — where to run
gitcommands. Default: the current repo. - Diff range — preferred form is
<base>...<head>(three dots). Default if not specified:git diff origin/main...HEAD. - Stated goal (optional) — a description of what the change is meant to accomplish (e.g. an MR/PR description, a spec, a ticket). Used for the "Consistency with stated goal" category. Skip that category if no goal was provided.
Steps
1. Read the stated goal (if any)
Read it before reading the diff so the goal is fresh while you're reviewing.
2. Read the diff
Run git diff <base>...<head> in the working directory and read the full
output. For very large diffs, also list changed files
(git diff --stat <base>...<head>) and prioritize files most relevant to the
stated goal.
Also read the commit messages in the range (git log <base>..<head>) — they
are part of what you review (see "Public-facing text" and "Git hygiene").
3. Walk every category
For each category below, look for issues in the diff. Be exhaustive — a single file can have multiple issues of the same type. Don't skip categories that look empty at a glance; spend a moment confirming.
For frontend (.tsx) changes, you MUST read docs/development/review/react.md
(generic React rules), docs/development/review/sculptor.md (Sculptor-specific
conventions: backend data hooks, Jotai atoms, component invariants),
docs/development/review/design.md (design-system usage, existing patterns,
UI copy), and docs/development/review/file_structure.md (file placement,
feature layout, naming) in full and apply every rule in them. Do not skip this
step. Do not rely on summaries elsewhere in this checklist or on prior
knowledge — the docs are the source of truth and are updated independently.
The file-structure doc also applies to frontend .ts changes (new files,
moves, renames).
For integration test changes (under sculptor/tests/integration/), you MUST
read the file docs/development/review/integration_tests.md in full and apply every rule
in it. Same reasoning as above.
4. Produce findings broken down by category
Output one section per category in the order they appear under "Categories" below. Every category must have a section in your output — including ones where you found no issues. This forces you to confirm you actually reviewed each category rather than letting empty ones slip past unnoticed.
For each category, write a heading with the category name, then either prose findings or an explicit "no issues" line.
Write each finding as a short paragraph, not as a table row. Lead with the severity tag in bold, then the file path and line numbers, then a one- to three-sentence explanation of what's wrong and why it matters. Multiple findings in the same category go as separate paragraphs, blank-line separated.
Example output:
### Correctness
**HIGH** — `path/foo.py:42-48`. `bar()` is called with `None` when `x` is
empty, and `bar` does not guard against that. This will raise an
`AttributeError` at runtime on the empty-list path, which the new tests
don't cover.
**MEDIUM** — `path/baz.py:101`. The loop runs `range(len(items) - 1)`, so
the last item is silently skipped. Likely an off-by-one introduced when the
slice was removed in this change.
### Consistency with stated goal
No stated goal provided — section skipped.
### Test coverage
No issues found.Each section must be one of:
- One or more prose findings (each a paragraph led by a bolded severity tag), OR
- The literal line
No issues found., OR - For "Consistency with stated goal" only, when no goal was provided:
No stated goal provided — section skipped.
Do NOT collapse multiple empty categories into a single "no issues" note. Do NOT omit a category section. If you do, it signals you didn't review it. Do NOT use markdown tables — prose only.
Severity:
- CRITICAL — crashes, data loss, security holes, silently wrong behavior
- HIGH — likely bugs, broken edge cases, missing tests for risky paths, breaking API/schema changes
- MEDIUM — maintainability issues, scope creep, style guide violations, unclear code that will lead to bugs
- LOW — nits, minor cleanup, naming, comments
5. Summarize
After the per-category sections, write a short summary (2–4 bullets):
- Whether the change accomplishes the stated goal (if a goal was provided)
- Top 1–3 things to address before merging
- Anything that should block the change
- "No issues found" is a valid summary if the diff is clean
Categories
Correctness
- Logic errors: off-by-one, wrong operator, inverted conditions
- Edge cases:
None/empty/zero/negative inputs, boundary values - Race conditions, ordering bugs in async/concurrent code
- Resource lifecycle: file handles, sockets, subscriptions, listeners, subprocesses cleaned up on all paths (including error paths)
- State invariants: any path that leaves an object in an inconsistent state
Consistency with stated goal
- Does the implementation match the stated intent?
- Are there functional changes not mentioned in the goal (scope creep)?
- Is anything described in the goal missing from the diff?
- Are there obvious follow-ups the goal implies but the diff doesn't deliver?
- Does the fix exercise the full user flow described in the goal, not just the narrow symptom? If the goal describes a multi-step user flow (e.g. "background subagent renders as 0.0s") and the fix only addresses one moment in that flow, that's a partial fix — flag it. The bar is: a reviewer should be able to follow the original repro and confirm the whole flow works, not just that the literal symptom no longer appears.
Test coverage
- New behavior has tests
- Bug fixes include a regression test that fails without the fix
- Tests are focused — one logical assertion per test
- Critical paths covered: error paths and edge cases, not just the happy path
- No tests skipped/
xfail/disabled without justification - No flaky patterns introduced (sleeps, real network, time-of-day deps)
Proof of work completeness
This category applies when the stated goal is an MR/PR body produced by an autonomous workflow (e.g. /sculptor-workflow:fix-bug). Skip the category if no stated goal was provided, or if the stated goal is a spec/ticket rather than an MR body.
- UI-visible bugs MUST have before/after screenshots. If the diff touches any frontend file (
sculptor/frontend/, any.tsx,.css, or other UI surface) and the MR body's "Before" or "After" slots lack an embedded image (e.g.<img src="...">or a markdown image link), flag it as HIGH. Test output is not a substitute. - Non-UI bugs MUST have failing-then-passing test output. If the diff has no UI surface and the MR body's "Before" or "After" slots lack a fenced code block with test output, flag it as HIGH.
- Test commit hashes MUST be present in the Test block. If the body says "Failing-test commit:
<hash>" with a placeholder or empty hash, flag it. - Root cause and Fix blocks MUST be substantive. Single-sentence "fixed the bug" entries are not acceptable; flag any block under two sentences.
- Repro steps MUST be exact. Vague repro steps ("open the app, click around") that a reviewer cannot follow verbatim are not acceptable.
Dead code & leftover artifacts
- Unused imports, variables, functions, types, components
- Commented-out code
- New
TODO/FIXME/XXXcomments without an owner or ticket - Debug statements:
console.log,print(...),pdb,breakpoint(),debugger - Unused feature flags, config knobs, env vars
- Stale code paths replaced by the change but not deleted
Comments
- Comments describe the code and explain why; they are not narration.
- No incidental history or defensive justification — strip comments that explain today's bug fix, argue for the code's correctness, or narrate how the code used to work. The comment should help a future maintainer, not relitigate the change that introduced it.
- No restating volatile facts from the surrounding code (a count of subclasses, a list of variants/enum cases, the call sites of a function). These pin the comment to a moment in time and rot quickly — follow DRY.
- No ASCII-art banners or box-drawing section dividers. They add visual noise without conveying anything a plain one-line comment does not.
- No editorializing — strip frustration, jokes, hedging-as-mood, and exaggeration, keeping any underlying fact.
- No pointers to throwaway docs, tickets, or plan phases —
agent_docs/...paths,REQ-*requirement IDs, or implementation-plan phase references. The comment must stand on its own. - No real people's names in comments, docstrings, or test strings. Reword
(e.g. "check with the team"), and use a generic placeholder (
dev,foo,alice) for usernames in/Users/<name>/paths or example branch names.
Error handling
- No bare
except:or unconditionalexcept Exception: - Errors carry context (custom exception types where appropriate)
- No silently swallowed errors (
except: passetc.) - User-facing errors are actionable
- External I/O has timeouts and reasonable retry/backoff where appropriate
Security & secrets
- No secrets, tokens, API keys, or credentials in code or configs
- Input validated at trust boundaries
- Auth/permission checks present where required
- No untrusted input fed to subprocess/eval/SQL/template without sanitization
- Sensitive values not logged
Type safety
- Type hints on new/changed public functions
- No new
Anytypes unless justified - Pydantic models for structured data, not ad-hoc dicts
- No new Pyrefly errors; suppressions justified with a comment
- For frontend: TypeScript types up to date; if
ElementIDschanged, runjust generate-api
Backwards compatibility
- API/schema/config changes are documented and have migration paths
- Persisted data formats: forward-compatible reads if format changes
- Public CLI flags / env vars: deprecation considered before removal
- Frontend↔backend contract changes shipped together
Frontend issues (for .tsx changes)
Required: Read docs/development/review/react.md (generic React rules),
docs/development/review/sculptor.md (Sculptor-specific frontend conventions),
docs/development/review/design.md (design-system usage, existing patterns, UI copy),
and docs/development/review/file_structure.md (file placement, feature layout,
naming — also applies to frontend .ts changes) in full with the Read tool, and
apply every rule in them. The rules cover effects,
state, refs, render purity, performance, props, lists, backend data hooks,
Jotai atom usage, component-level invariants, design-token and component-reuse
conventions, UI copy, code placement, and naming — detailed enough that
summarizing them here would lose
information, so this section intentionally does not list them. If you find
yourself reviewing a .tsx change without having opened all four docs in the
current session, stop and read them.
Beyond the docs: IconButton in a Flex uses gap="2" (per CLAUDE.md).
Integration test issues (for changes under sculptor/tests/integration/)
Required: Read docs/development/review/integration_tests.md in full with the Read
tool and apply every rule in it. The rules cover Playwright assertion
patterns, test isolation, and POM usage — they're detailed enough that
summarizing them here would lose information, so this section intentionally
does not list them. If you find yourself reviewing an integration test change
without having opened that doc in the current session, stop and read it.
Style guide & ratchets
- All imports at top of file (no inline imports unless
# noqa: E402) - No relative imports
- No nested/inline function definitions (except simple lambdas)
- Boolean variables prefixed with
is_/has_/should_/etc. - No
num_prefix (usecount_or_idxsuffix) - Early-exit pattern preferred over deep nesting
- No magic numbers — use named constants
- No mutable default arguments
- Comments follow the Comments category above
- Run
just ratchetsif you suspect any counts changed; flag any increases
Git hygiene
- Commit messages explain the "why"
- Commits are atomic — one logical change each
- No unrelated changes mixed in
Public-facing text (commit messages & PR/MR description)
Commit messages and the PR/MR title and description are published to a public
repository — review them as permanently, world-readable artifacts. Read the
commit messages in the range (git log <base>..<head>) as well as the stated
goal (the PR/MR body, when one was provided). Flag any of the following:
- CRITICAL — secrets, tokens, credentials, or private keys in a commit message or PR/MR body.
- PII — real people's full names, personal email addresses, individual
usernames, or local filesystem paths embedding a username (
/Users/<name>/). These should be reworded to roles or generic placeholders (dev,<user>). - Internal-only leakage — internal hostnames/URLs, internal
service/tool/infra names, internal dashboards, customer names or
customer-specific data, or verbatim private ticket/chat discussion. A bare
ticket ID reference (e.g.
SCU-1447) is fine; pasting the ticket's private contents is not. - Security-sensitive detail — exploit steps or descriptions of internal security mechanisms written in a way that would aid an attacker. Security fixes should be described at a safe altitude, not as a reproduction recipe.
- Candid internal commentary — business strategy, unreleased plans, speculation about competitors, or remarks about individuals.
This is the same standard as the Comments category, extended from code comments to the commit/PR prose. See also CLAUDE.md, "Public Visibility: Commit Messages and PR Descriptions".
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

