agentleFS
RemiMyrsetRemiMyrset/roots/.claude/skills/new-spec/SKILL.md

new-spec

Skill0 starsChanged 44 days agoMITView on GitHub

Create a new specification (capability or entity spec) in the right area with the correct format. Use when the user says "new spec", "spec this endpoint/entity/behavior", or new externally observable behavior is being designed. Also use unprompted when a change adds or alters externally observable behavior (a route, command, flag, exit code, or invariant) that no existing spec covers.

12 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 1 is distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 11 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

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

    Create a spec under docs/internal/specs/<area>/.

    line 8
  2. Very specific:

    If this is the roots template itself, write nothing under docs/internal/specs/.

    line 10
  3. Very specific:

    Every child starts with a copy of docs/internal/specs/, so it stays clean here (see "What roots chose" in docs/template/conventions.md).

    line 13
  4. Very specific:

    Run pnpm docs:gen, then pnpm docs:check.

    line 31
  5. Distinctive:

    If the request names the capability or entity, use it.

    line 35

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

New specification

Create a spec under docs/internal/specs/<area>/.

  1. If this is the roots template itself, write nothing under docs/internal/specs/. Use the fork and template checks in step 0 of the first-run skill; a contribution fork of roots counts as the template. Every child starts with a copy of docs/internal/specs/, so it stays clean here (see "What roots chose" in docs/template/conventions.md). A template mechanic's contract lives in its page under docs/template/, in the shape of sync-template.md: Source, Tests, and Last reviewed bullets, which pnpm docs:check holds to the spec rules. Edit that page, or add one and list it in docs/template/README.md, then stop.
  2. Decide the kind, capability or entity, per "Spec kinds" in docs/template/spec-discipline.md.
  3. Pick or create the <area> folder (for example api/, cli/, domain/). The handbook sidebar and pnpm docs:list discover new areas automatically.
  4. Copy docs/internal/specs/_template.md to <area>/<name>.md and fill it: Source and Tests bullets as backticked repo-relative paths ((pending) is legal spec-first), - **Last reviewed:** today. Purpose, Non-goals, Contract (precise inputs/outputs or invariants), Behavior as Given/When/Then branches, Edge cases.
  5. Behavior is numbered branches, each a binary check. The test the spec must pass is under "Spec kinds" in docs/template/spec-discipline.md; a branch that fails it is not specified yet.
  6. Run pnpm docs:gen, then pnpm docs:check; both must pass. If this spec ships with a behavior change, source and tests move in the same PR (three-place sync).

If the request names the capability or entity, use it.

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.