agentleFS
leanEthereumleanEthereum/leanSpec/.claude/skills/review/SKILL.md

review

Skill143 starsChanged 2 months agoMITView on GitHub

Quick-reference checklist for code review conventions in leanSpec

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

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. 0 are common, 8 are distinctive, and 5 are very specific to this project.

  • 0

    Common

    Most of the 157 edited versions we read keep these.

  • 8

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    All imports at file top — no lazy imports inside functions

    line 12
  2. Very specific:

    No confusing renames — use qualified access (x25519.X25519PublicKey)

    line 13
  3. Very specific:

    Never quote annotations when from __future__ import annotations is present

    line 18
  4. Very specific:

    Prefer narrow domain types (Bytes32, PeerId, RequestId) over raw bytes

    line 19
  5. Distinctive:

    No example code in docstrings — unit tests serve as examples

    line 26
  6. Very specific:

    No section separator comments (# ====, # ----)

    line 27
  7. Distinctive:

    Never use explicit function or method names in docs — names change

    line 32
  8. Distinctive:

    Write short, scannable sentences — one idea per line

    line 33
  9. Distinctive:

    Use bullet points or numbered lists for multiple items

    line 34
  10. Distinctive:

    Never remove existing documentation unless directly invalidated by a code change

    line 35
  11. Very specific:

    Use pytest.raises(ExceptionType, match=r"...") for error tests

    line 41
  12. Distinctive:

    No backward compatibility code — no shims, aliases, or re-exports

    line 46
  13. Distinctive:

    No unnecessary abstractions — inline is often better for spec code

    line 47

“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 - Code Review Checklist

A concise checklist distilled from CLAUDE.md for reviewing leanSpec code.

Imports

  • All imports at file top — no lazy imports inside functions
  • No confusing renames — use qualified access (x25519.X25519PublicKey)
  • from __future__ import annotations in every file

Type Annotations

  • Never quote annotations when from __future__ import annotations is present
  • Prefer narrow domain types (Bytes32, PeerId, RequestId) over raw bytes
  • Complete type hints on all function signatures

Code Style

  • Line length: 100 characters max
  • Google docstring style
  • No example code in docstrings — unit tests serve as examples
  • No section separator comments (# ====, # ----)
  • Module-level constants use docstrings, not comments

Documentation

  • Never use explicit function or method names in docs — names change
  • Write short, scannable sentences — one idea per line
  • Use bullet points or numbered lists for multiple items
  • Never remove existing documentation unless directly invalidated by a code change

Testing

  • Full equality assertions — assert the whole object, not individual fields
  • Descriptive test names explaining the scenario
  • Use pytest.raises(ExceptionType, match=r"...") for error tests
  • Boundary values derived from source constants, never hardcoded

Architecture

  • No backward compatibility code — no shims, aliases, or re-exports
  • No unnecessary abstractions — inline is often better for spec code
  • Simplicity over abstraction — readers should understand top-to-bottom
  • SSZ types: domain-specific names (Attestations) over generic (List4096)

Before Committing

just fix    # Auto-fix lint, formatting, and markdown
just check  # Verify all checks pass

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.