agentleFS
tcrosslandtcrossland/claude-code-methodology/CLAUDE.md

claude-code-methodology

CLAUDE.md0 starsChanged 5 months agoApache-2.0View on GitHub

This repository is the methodology itself: reference docs, a CLAUDE.md template, and (eventually) a Claude Code plugin. It is a documentation project: the source has no build or runtime. (The MkDocs site is an optional publish build — never a prerequisite for reading or editing the Markdown; see docs/design/0002-publish-as-doc-site.md.) - British English throughout (DD/MM/YYYY, £/€ before figures). - Keep this file lean; it loads every turn. Detailed material lives under docs/. - Docs live under docs/; the curated changelog stays…

The file

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

5 rules. About 0 are common, 2 are distinctive, and 3 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.

  • 3

    Very specific

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

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

    Keep this file lean; it loads every turn.

    line 11
  2. Distinctive:

    Plan before you leap: If the approach isn't obvious — a structural refactor, or anything touching an invariant above — drop into plan mode …

    line 43
  3. Very specific:

    Persist a plan only when it must outlive the session: Write docs/plans/<name>.md when the work is multi-stage or won't finish before the …

    line 46
  4. Very specific:

    Review before merge: Run the code-reviewer subagent on the diff before any merge to the main branch.

    line 52
  5. Distinctive:

    Verify, don't assume: Run the commands above to confirm a change works, and check it against the Definition of Done, before reporting it …

    line 54

≈ “Common” is an estimate: at least 1 in 5 of the 27,641 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

A File-First Operating Model for Claude Code

This repository is the methodology itself: reference docs, a CLAUDE.md template, and (eventually) a Claude Code plugin. It is a documentation project: the source has no build or runtime. (The MkDocs site is an optional publish build — never a prerequisite for reading or editing the Markdown; see docs/design/0002-publish-as-doc-site.md.)

Invariants

  • British English throughout (DD/MM/YYYY, £/€ before figures).
  • Keep this file lean; it loads every turn. Detailed material lives under docs/.
  • Docs live under docs/; the curated changelog stays at the repo root as CHANGELOG.md.
  • The methodology must stay internally consistent: section cross-references (§N) and appendix letters (A–O) are load-bearing — update them together when editing.

Layout

  • docs/methodology.md — the main reference (narrative §1–§11).
  • docs/appendices/ — the drop-in artefacts (Appendices A–O), grouped by type; README.md indexes them.
  • docs/packaging-as-a-plugin.md — plugin packaging companion.
  • templates/CLAUDE.template.md — the starter template artefact.
  • CHANGELOG.md — user-facing changes (Keep a Changelog, SemVer).
  • docs/backlog.md — ordered candidate work (§8 / Appendix F).
  • mkdocs.yml + requirements.txt — optional doc-site build (ADR 0002); docs/ is the source.

Conventions

  • Commits: Conventional Commits, imperative mood, one concern per commit. The methodology is the product, so type by what changed for a reader — feat new guidance/artefact, fix corrected guidance, refactor restructuring, chore repo plumbing; reserve docs for trivial infra. Types mirror the backlog's feat/fix/debt/chore (§8) and pre-sort into CHANGELOG categories at /release.
  • Internal/private material lives in gitignored docs/local/; never name or describe its contents in tracked files or commit messages — use neutral "local" terminology.
  • Prose in the public docs follows the house voice in docs/style.md.

Working agreement

These rules govern how we work, not what the code does. Global working rules (worktree hygiene, verify-before-asserting) live in ~/.claude/CLAUDE.md and apply on top of these.

  • Plan before you leap. If the approach isn't obvious — a structural refactor, or anything touching an invariant above — drop into plan mode and agree the approach before editing. This is cheap; use it freely, even for a one-file change.
  • Persist a plan only when it must outlive the session. Write docs/plans/<name>.md when the work is multi-stage or won't finish before the context compacts or you stop — that is what the file is for (§3). Otherwise do the thinking and skip the file.
  • One plan file, status folded in. Each plan is a sequence of Stages worked through in order; status (current stage, ticked steps, deviations, decisions) lives in the same file. After a compaction or restart, resume from the active plan.
  • Review before merge. Run the code-reviewer subagent on the diff before any merge to the main branch. There is no second reviewer; this is it.
  • Verify, don't assume. Run the commands above to confirm a change works, and check it against the Definition of Done, before reporting it done.

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.