agentleFS
Sign inStart free
TangleMLTangleML/tangle-ui/CLAUDE.md

tangle-ui

CLAUDE.md104 starsChanged 3 days agoApache-2.0View on GitHub

Code must be self-explanatory. Default to no comment. - A comment is justified only when it states a non-obvious why the code and its names cannot: a workaround, a race condition, an external-system quirk, a subtle ordering constraint. - Never narrate what the code does. No step-by-step narration (// fetch the data), no section-divider banners (// ─── Helpers ───), no restating a name. - Never comment interface fields, type members, component Props, or config-object fields — leading or trailing, //…

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

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

  • 2

    Very specific

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

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

    Never narrate what the code does.

    line 9
  2. Very specific:

    Never comment interface fields, type members, component Props, or config-object fields — leading or trailing, // or / */.

    line 11
  3. Distinctive:

    Prefer renaming, extracting a well-named function, or a named constant over adding a comment.

    line 15

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

Tangle-UI

Comments

Code must be self-explanatory. Default to no comment.

  • A comment is justified only when it states a non-obvious why the code and its names cannot: a workaround, a race condition, an external-system quirk, a subtle ordering constraint.
  • Never narrate what the code does. No step-by-step narration (// fetch the data), no section-divider banners (// ─── Helpers ───), no restating a name.
  • Never comment interface fields, type members, component Props, or config-object fields — leading or trailing, // or /** */. A field that needs a comment to explain what it is has a naming problem: rename it. (Only exception: the prop contract of a shared design-system primitive in src/components/ui/.)
  • Prefer renaming, extracting a well-named function, or a named constant over adding a comment.
  • JSDoc only for genuinely complex functions and shared public APIs — never as a substitute for a good name.
  • A stale comment is worse than none: update comments with the code, and delete ones you invalidate.

Removing a comment that violates the above is always in scope for a change you are already making.

Everything else

Project conventions live in .claude/skills/ — start with project-conventions, plus typescript-standards, react-patterns, ui-primitives, tangle-domain, tanstack-query, tanstack-router, vitest-testing, e2e-testing, accessibility, and open-source.

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.

Check your setup, free