agentleFS
chrille0313chrille0313/agentic-monorepo-template/CLAUDE.md

agentic-monorepo-template

CLAUDE.md4 starsChanged 3 months agoMITView on GitHub

This repo is agentic-first: features flow through a PM -> implementer -> reviewer pipeline (see README). These instructions are shared by every agent in that pipeline. Check, test, and build are hard gates: they must exit 0 before agent review means anything. Review layers on top of deterministic checks, never replaces them, and one runner owns each gate rather than every agent repeating it. Run and smoke exist so agents can verify behavior, not just code: this repo treats "an…

The file

We split this CLAUDE.md into the rules it gives an agent

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Check, test, and build are hard gates: they must exit 0 before agent review means anything.

    line 16
  2. Distinctive:

    Run and smoke exist so agents can verify *behavior*, not just code: this repo treats "an agent can start and exercise the app" as a …

    line 19
  3. Very specific:

    If a contract command is still TODO, say so and stop.

    line 25
  4. Very specific:

    If the repo has a GitHub remote, GitHub Issues are the backlog.

    line 37

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “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
CLAUDE.md

Agentic Monorepo Template

This repo is agentic-first: features flow through a PM -> implementer -> reviewer pipeline (see README). These instructions are shared by every agent in that pipeline.

Command contract

<!-- Filled in by /setup-stack. Every agent verifies work with these exact commands; CI (.github/workflows/ci.yml) runs the same ones. Keep them fast and deterministic. -->
  • Check (lint + typecheck): TODO: run /setup-stack
  • Test: TODO: run /setup-stack
  • Build: TODO: run /setup-stack
  • Run (start the app so an agent can exercise it, via a stable port/URL or CLI entrypoint): TODO: run /setup-stack
  • Smoke (drive the running app through its critical user journeys; deterministic, seeded): TODO: run /setup-stack

Check, test, and build are hard gates: they must exit 0 before agent review means anything. Review layers on top of deterministic checks, never replaces them, and one runner owns each gate rather than every agent repeating it. Run and smoke exist so agents can verify behavior, not just code: this repo treats "an agent can start and exercise the app" as a first-class requirement of the stack. Smoke is a living suite that every feature adding a user journey extends; a command that still only proves the process boots has stopped earning its runtime. The full suite gates the PR in CI.

If a contract command is still TODO, say so and stop. Do not invent a substitute.

Layout

This is a monorepo with a fixed structure, independent of stack and tooling:

  • apps/<name>: deployable applications. Every deployable lives here, even when there is only one.
  • packages/<name>: shared libraries used by apps.
  • Group feature code by domain (vertical slices), not by technology.

Backlog

  • If the repo has a GitHub remote, GitHub Issues are the backlog. Use gh issue list/view.
  • Otherwise, BACKLOG.md is the backlog.
  • A task is ready when it has a spec: goal, acceptance criteria, out-of-scope, verification plan.
  • Dependencies: label the dependent issue blocked and write "Blocked by #N" in its body. The PM removes the label once every blocker is closed.
  • The in-progress label marks a task actively being worked; /build sets and clears it.
  • A GitHub Project board, when configured, mirrors issue state for humans (.github/workflows/board-sync.yml). Issues stay the source of truth; agents never read or update the board.

Conventions

  • Work happens on branches, never directly on main. Agents open PRs; humans merge.
  • One task = one branch = one PR. Branch names: agent/<short-slug>.
  • Conventional commits (feat:, fix:, chore:, ...), enforced by the commits job in CI.
  • Commit messages are for developers; release notes are for users. A PR that changes user-facing behavior also includes a short note written for users, in whatever form the release tooling collects (changeset file, fragment, ...); the spec's Goal section is good raw material. Release notes are those collected notes, never the commit log.
  • Verification is executed, not argued: any claim about behavior is backed by a command that actually ran (a test, a smoke check, a reproduced output). Run the narrowest check that could fail on what you just touched; the full contract runs once, at the boundary.
  • Tasks are sized by cohesion: one task is what can be finished coherently and reviewed in one sitting. A user-visible surface — a page, a flow, a design system — is one such unit, since splitting one is how interfaces end up looking assembled rather than designed.
  • Committed generated files are regenerated, never hand-edited. Run the generator, commit its output. The gates job fails when running the contract changes tracked files.
  • Agent prompts state outcomes and constraints, not step-by-step procedures. Keep them short; trust the model. One owner per rule: repo-wide conventions live here, an agent's behavior lives in its agent file, orchestration lives in the skill that runs 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.