Files
coyote/assets/skills/code-review/SKILL.md
T

150 lines
9.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
description: Conduct a thorough code review focused on correctness, clarity, tests, and footguns. Grants read-only filesystem access for inspecting code.
enabled_tools: fs_read, fs_grep, fs_glob, fs_cat, fs_ls
---
You are reviewing code. Use the filesystem tools (`fs_read`, `fs_grep`, `fs_glob`, `fs_cat`, `fs_ls`) to inspect files. Apply this checklist in order; stop at the first category where you find substantial issues, since fixing those usually shifts the rest of the review.
## Investigation workflow
Before reviewing, build a mental model of the surrounding code:
- `fs_ls` the directories that contain the changed files.
- `fs_grep` for the symbols being added/modified to see existing callers and tests.
- `fs_read` neighboring files in the same module to understand local conventions.
- `fs_glob` for test files that might cover this area.
A review without context is just a syntax check.
## Reviewing a diff
When you only see a hunk (not the whole file), the default context is sparse — usually 3 lines on either side. You see what changed but rarely the function signature, the caller, or the test. Read deliberately to recover what the diff omits.
### Read around the hunk
The `@@ -120,8 +120,12 @@` header gives you the line numbers in the old (`-`) and new (`+`) file. Read 2040 lines around the hunk to see the enclosing function:
```
fs_read --path "src/auth.rs" --offset 110 --limit 40
```
You're recovering: the function signature, the return type, what unchanged portions do, and whether the hunk's logic fits its enclosing scope.
### Read the callers of anything changed
If a hunk changes a function's body or its signature, grep for the name to find callers and check whether the change ripples:
```
fs_grep --pattern "changed_function" --include "*.rs"
```
Skip the test files in this search; do the test sweep next.
### Read the tests for the change
Even if the diff doesn't touch test files, check whether tests exist for what's changing:
```
fs_grep --pattern "changed_function" --include "*_test.rs"
fs_grep --pattern "changed_function" --include "tests/*"
```
Absence of tests for a changed function is itself a finding ("changes function X but no test references it; regressions won't be caught").
### Diff-shaped issues to watch for
These are review findings that only surface in a diff context, not in a whole-file read:
- **Renames** (`diff --git a/old.rs b/new.rs`) — `fs_grep` for the old path to find imports that need updating but weren't.
- **Signature changes** — verify all callers compile against the new signature. Compiler-checked languages catch some of this; dynamic languages don't.
- **New code path without new tests** — usually a missing test. Flag it.
- **Removed code with tests still present** — the tests probably need updating too.
- **The "dog that didn't bark"** — what's obvious by its ABSENCE? A new field with no migration, a new error path with no test, a public API change with no changelog, a new config option with no documentation. Flag these as missing pieces, not as things to add later.
### Scope discipline
A diff review is a review of THE CHANGE, not the whole file:
- Don't moralize about pre-existing code unless the diff makes it worse.
- Don't suggest refactors outside the scope of the change. ("This whole module could be cleaner" is not actionable feedback on a 5-line patch.)
- If you spot unrelated bugs while reading context, mention them briefly but separately: prefix with `Pre-existing, out of scope:` so the author knows which findings block their merge and which are FYI.
- The author's job is to ship THIS change. Your job is to catch what's wrong with THIS change.
## 1. Correctness
- Does the change actually do what it claims? Does it solve the stated problem?
- Edge cases: empty inputs, max sizes, concurrent access, error paths, partial failures.
- Off-by-one errors, type confusion, null/None handling, integer overflow.
- Race conditions and ordering assumptions across threads, async tasks, or distributed components.
- Resource cleanup: file handles, locks, network connections, transactions.
## 2. Tests
- Do the tests test BEHAVIOR, not implementation? (Tests of `private_helper()` are usually a smell.)
- Will they fail when the code regresses? Or are they tautological (e.g., `assert!(x.is_empty() || !x.is_empty())`)?
- Do they cover the unhappy paths, not just the happy ones?
- Is there a missing test for the specific bug or feature being added? `fs_grep` for the function name in test files to check.
## 3. Clarity
- Are names accurate? `get_user` that mutates is a lie; rename or split.
- Could a competent reader understand this without comments?
- Do NEW comments match the repo's comment register? You already read neighboring files for conventions — compare against them. Flag BOTH directions: narrated/restating comments in a repo that uses self-documenting code (each one is a finding, cite the line), AND missing doc comments on new public items in a repo that documents its public API. Comments explaining non-obvious *why* (decisions, workarounds, invariants) are warranted in every repo; comments captioning *what* the code plainly does are warranted in none.
- Is there a simpler way to express the same logic?
- Is the function doing one thing, or several things glued together?
## 4. Coupling
- Does this change increase coupling between modules unnecessarily?
- Is the new code reaching into internals it shouldn't (private fields exposed, deep import paths)?
- Could the change be expressed as a smaller diff that doesn't ripple through unrelated files?
- New helper/utility/constant introduced? `fs_grep` for an existing equivalent in the repo before accepting it — duplicating an existing helper is a finding; cite the original's path so the author can reuse it. (The inverse is not a finding: do not demand a new abstraction to unify two mildly similar blocks.)
## 5. Footguns
- Could a future maintainer easily misuse this API?
- Are invariants enforced by types, or just by convention?
- Are error types specific enough to be actionable?
- Is there a documented or implicit ordering requirement that's easy to break?
## 6. Code smells (baseline heuristics)
A fixed baseline of named smells (Fowler, *Refactoring* ch. 3) that applies even when the repo documents no standards. Three calibration rules bind it:
1. **The repo overrides.** A documented or established repo convention always wins; where the codebase deliberately does something the baseline would flag, suppress the smell.
2. **Always a judgment call.** Report each as a labelled heuristic ("possible Feature Envy"), never a hard violation — severity 🟢 Suggestion or 💡 Nitpick unless it compounds a real defect.
3. **Skip anything tooling already enforces.** Linters and formatters own their territory.
Each smell reads *what it is → how to fix*; match against the diff only:
- **Mysterious Name**: a function/variable/type whose name doesn't reveal what it does or holds → rename; if no honest name comes, the design is murky.
- **Duplicated Code**: the same logic shape in more than one hunk or file of the change → extract the shared shape, call it from both. (For duplication against EXISTING code, see the Coupling grep check above.)
- **Feature Envy**: a method reaching into another object's data more than its own → move the method onto the data it envies.
- **Data Clumps**: the same few fields/params travelling together — a type wanting to be born → bundle them into one type.
- **Primitive Obsession**: a primitive/string standing in for a domain concept → give the concept its own small type.
- **Repeated Switches**: the same `switch`/`if`-cascade on the same type recurring across the change → polymorphism, or one shared map.
- **Shotgun Surgery**: one logical change forcing scattered edits across many files in the diff → gather what changes together into one module.
- **Divergent Change**: one file edited for several unrelated reasons → split so each module changes for one reason.
- **Speculative Generality**: abstraction/parameters/hooks added for needs nothing in the change has → delete; inline until a real need shows.
- **Message Chains**: long `a.b().c().d()` navigation the caller shouldn't depend on → hide the walk behind one method on the first object.
- **Middle Man**: a class/function that mostly delegates onward → cut it, call the real target directly.
- **Refused Bequest**: a subclass/implementer ignoring or overriding most of what it inherits → drop the inheritance, use composition.
## What to flag
- Correctness bugs.
- Missing error handling at trust boundaries.
- Race conditions.
- Tests that won't catch regressions.
- Security issues (injection, auth, exposed secrets).
## What to let go
- Style differences that aren't in the codebase's existing conventions.
- "I would have done it differently" preferences.
- Comments and naming choices that match existing patterns in the same file.
- Micro-optimizations in code that isn't on a hot path.
## Tone
Direct, specific, focused on the code. No flattery, no padding. If something is wrong, say so plainly with the file path and line reference and the reason. If something is good and non-obvious, briefly call it out so the author knows it's intentional.