agentleFS
pc-stylepc-style/x-md/CLAUDE.md

x-md

CLAUDE.md192 starsChanged 8 days agoMITView on GitHub

Read AGENTS.md first — it holds the conventions for this repo (build order, design tokens, landing copy frame, the error module, versioned routes, quotas, discovery documents, and the checks to run before pushing). This file only adds what is specific to working here with Claude Code. - Checks before pushing: bun run test and bun run build (the build starts with tsc, so a separate run is redundant). After touching lib/openapi.ts, run bun run openapi:build then bun run sdk:build and…

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read AGENTS.md first — it holds the conventions for this repo (build order, design tokens, landing copy frame, the error module, versioned …

    line 3

≈ “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

x-md

Read AGENTS.md first — it holds the conventions for this repo (build order, design tokens, landing copy frame, the error module, versioned routes, quotas, discovery documents, and the checks to run before pushing). This file only adds what is specific to working here with Claude Code.

  • Checks before pushing: bun run test and bun run build (the build starts with tsc, so a separate run is redundant). After touching lib/openapi.ts, run bun run openapi:build then bun run sdk:build and commit the regenerated public/openapi.json and SDK generated/ files — bun run build rewrites that file in place, so openapi:check can never fail straight after a build; it is the CI guard against a stale committed copy.
  • main takes a PR. Its ruleset requires the build and CodeRabbit checks, a deployment to the Preview environment, signed commits, and the branch up to date with main. No approvals are required, and merges must be squash or merge — rebase is disabled. An unsigned commit blocks the merge no matter how green everything else is. Repo admins hold an always-on bypass; other contributors do not.
  • Two CodeQL alerts are dismissed as false positives, with the reasoning on the alerts themselves: js/xss-through-exception in lib/apierror.ts and js/reflected-xss in api/oembed.ts. Both responses set an explicit JSON content type via setHeader and the site sends nosniff globally; CodeQL flags res.send(string) because Express infers text/html when no type is set. Do not "fix" them — HTML-escaping inside a JSON body corrupts legitimate text, and res.json() would clobber the problem+json type the RFC 9457 error handling depends on.
  • Scoring work is measured against the scorer's own data, not guesswork: https://ora.ai/api/checks lists all 125 checks with their criteria and weights, and https://ora.ai/api/score/mdfromx.com gives the per-check result with the exact evidence string. npx is-agentic mdfromx.com reads the latest stored report and cannot force a re-scan — trigger one at https://is-agentic.com/scan/mdfromx.com.

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.