agentleFS
fab-codesfab-codes/agent-workflow-template/.claude/skills/review/SKILL.md

review

Skill2 starsChanged 25 days agoMITView on GitHub

Maintainability review against AGENTS.md — over-engineering, consistency, comments, fit with the issue

192 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use close-spec, design-with-images and 10 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.
  • dzhngSkill

    close-spec

    When a spec under specs/<feature>/ is done shipping (a write-spec build, or any planned task that produced a spec), archive it to specs/done/ and rewrite it from a build-plan into a durable rationale — the why, the principles, the invariants — pointing back to the real code for the how. Use when implementation has landed and the plan no longer matches what shipped, or the user says a feature/spec is finished. Pairs with [write-spec](../write-spec/SKILL.md) (the plan this closes) and [review](../review/SKILL.md) (run before closing).

    Also in 5 projects that use this

  • dzhngSkill

    design-with-images

    Explore UI and visual design with image generation, then iterate the real implementation against the user-selected concept. Use when brainstorming visual directions, offering mockup variants, or implementing an approved generated design; do not stop at the mockups or the first code approximation.

    Also in 5 projects that use this

  • LambenthanSkill

    daily-arxiv

    每日从 arXiv 拉取新论文,过滤相关性,auto-ingest 高优先级论文,检测 SOTA 更新

    Also in 5 projects that use this

  • LambenthanSkill

    exp-eval

    实验判决门:Review LLM 独立评判实验结果 → 4 种判决路径 → 自动更新 claims confidence、ideas status、graph edges

    Also in 5 projects that use this

  • +3 more from dzhng
  • +5 more from Lambenthan

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 157 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run deno task lint and deno task invariants.

    line 15

“Common” is measured: kept by at least 6 in 10 of the 157 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Review

Target: $ARGUMENTS — if empty, the uncommitted changes (git status --porcelain and git diff).

This is a reading, not an intervention: produce a report, do not modify files. The user decides on the fixes after seeing the findings.

Before looking at the code

  1. Run deno task lint and deno task invariants. They cover the mechanical part of AGENTS.md §13. Do not redo by hand what they already flag: their outcome goes into the report as a status line, not as your finding.
  2. AGENTS.md is the source of truth. Cite it by section (§4.2) instead of summarizing it: if you find yourself rewriting a rule here, the rule already lives elsewhere and your job is to apply it, not to repeat it.
  3. Open the files, do not trust the diff. A consistency violation is invisible in a diff: it shows only when you compare the new file with the neighboring files that do the same thing.

Scope

This review looks at maintainability, and at whether the change stays within its issue. Correctness and security, that is the P0 and P1 items of Code Review Rules in AGENTS.md, are judged by the independent review (§12), on a different model: repeating them here would produce two correlated judgments counted as two independent checks. If while reading you still come across a problem of that kind, do not keep quiet about it: put it at the top of the report. But do not go looking for it.

The lenses

Lens 1 — Over-engineering (§4.2)

Question, for each abstraction: how many real callers does it have, right now? Count them with the Grep tool, not by intuition. Fewer than two callers → it gets inlined. The only exceptions are the architectural boundaries declared in §5.1.

Signals: factories, wrappers, registries, configuration layers; a folder with a single file; a five-line function used only once; caching, pooling or batching without a measurement that justifies them; optional parameters that no caller passes; flags never read; dead code; generalization for a second use case that does not exist yet.

Lens 2 — Consistency with the codebase (§5, §6, §10, §11)

The yardstick is not an abstract ideal: it is the files that already exist. Pick two or three sibling files — same layer, same role — and compare.

Question: would a reader understand that this file and the ones next to it were written by the same hand?

Signals: dependency direction inverted with respect to §5.1; an error handled in a form different from the single domain error model of §5.3; naming outside the table in §10; type where the neighbors use interface or vice versa; imports without the .ts extension, or without import type when importing only types; a test structure different from that of the other test files; a type crossing a boundary that the others respect; a domain concept named with a synonym that GLOSSARY.md lists under _Avoid_; a change that contradicts an ADR without a new ADR that replaces it; a glossary entry with implementation details, or an ADR that fails one of the three criteria of §11.

Lens 3 — Comments (§11, §4.3)

Question, for each comment: does it say WHAT the code does, or WHY it is done this way?

The what gets deleted: if it is needed to understand the block, the problem is the block's name or length, and that is the finding. The why stays, if it is true.

Signals of too much: JSDoc that restates the signature; decorative banners and section separators; commented-out code; comments that describe a previous version of the code and now lie; prose translations of an obvious line.

Signals of too little — they count as much as the previous ones: a trap of a critical dependency used without the note that explains it (§7), a security decision without its reason, a cast at a library boundary without the comment that justifies it (§6).

Lens 4 — Fit with the issue (§12, Rules; CLAUDE.md, Workflow)

The yardstick is the issue of the branch: gh issue view <n>, with <n> from feat/<n>-… or fix/<n>-…. Without an issue, write it in the report and skip this lens.

Question: does the change do what the issue decided, and nothing else?

Signals: a file or a behavior that no item of Decisions asks for; something the issue lists under Out of scope; a decision left undone without a word about it.

Report

For each finding, ordered by severity:

  • file.ts:line — the section of AGENTS.md it violates — what is wrong, in one sentence
  • why it is a problem here, with the concrete scenario that makes it visible
  • the proposed fix, in one line

Close with the status of deno task lint and of the invariants script.

If you find nothing, say so. An empty report is a valid and frequent outcome on code written following AGENTS.md. Padding it with marginal remarks so as not to hand it in empty is the fastest way to make this command useless.

What not to report

Stylistic preferences not written in AGENTS.md; anything already covered by deno fmt or deno lint; generic rewrites not tied to a project rule; feature proposals — even good ones, even small ones: they are out of scope under §4.2 and must be asked of the user, not slipped into a review.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.