agentleFS
allxsmithallxsmith/bestax/skills/CLAUDE.md

bestax / skills

CLAUDE.md14 starsChanged 8 days agoMITView on GitHub

These teach coding agents to use the library. They are published two ways — bundled into create-bestax (via scripts/sync-skills.mjs at its build time; every skill bundles, #540) and installable with npx skills add https://github.com/allxsmith/bestax --skill <name> — so treat changes here like library code: they get bug reports (#194, #195, #196, #197) and ship to users. The roster is read, not listed (#540). create-bestax/scripts/sync-skills.mjs and bestax-mcp/scripts/sync-skills.mjs each copy every directory holding a SKILL.md into their package, and scripts/gen-mcp-index.mjs discovers the…

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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:

    Every skill also ships in the bestax plugin: scripts/gen-skills-repo.mjs copies each skill directory's tracked files into …

    line 44
  2. Very specific:

    Every .ts and .tsx file under skills/ is also type-checked with the compiler options of create-bestax's vite-ts template, in pnpm test …

    line 73

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

skills/ — Agent Skills are a shipped product

These teach coding agents to use the library. They are published two ways — bundled into create-bestax (via scripts/sync-skills.mjs at its build time; every skill bundles, #540) and installable with npx skills add https://github.com/allxsmith/bestax --skill <name> — so treat changes here like library code: they get bug reports (#194, #195, #196, #197) and ship to users.

Layout contract (per skill)

  • SKILL.md — always loaded when the skill triggers; keep it short, put depth in references
  • references/ — read on demand by the agent (API tables, patterns, catalogs)
  • examples/ — optional runnable .tsx examples

Adding a skill

The roster is read, not listed (#540). create-bestax/scripts/sync-skills.mjs and bestax-mcp/scripts/sync-skills.mjs each copy every directory holding a SKILL.md into their package, and scripts/gen-mcp-index.mjs discovers the same set to generate the MCP manifest (it indexes, it does not bundle). A new skill therefore reaches every one by construction: there is no allowlist to join, and no per-skill bundling call to make. Full provenance (#385 vs #540) and the slot for a future per-skill opt-out live in create-bestax/scripts/sync-skills.mjs's header.

The install blocks (this README, the docs intro, the llms guide) are generated: pnpm gen rewrites them between their bestax:generated skills-install markers from the directory listing (#542, scripts/gen-skills-rosters.mjs), and the skills-roster conformance check fails while a committed block is stale. Do not hand-edit inside the markers.

What stays hand-written is prose that cannot be derived — the "Use it when…" tables, the layout tree, the scaffolded CLAUDE_MD roster, AGENTS.md's parenthetical. pnpm check:conformance --only=skills-roster holds those to the directory in both directions: it fails if one omits your new skill, and if one still names a skill you deleted. SKILL_ROSTERS in scripts/check-conformance.mjs is the authoritative list and the failure names every file you missed, so this file deliberately keeps no roster of rosters — that would be the same bug one level up.

The docs-site surfaces — the per-skill page under docs/docs/skills/, its entry in docs/sidebars.js, and the intro's bullet roster — are held by the same check through the slug transform (directory name minus the bestax- prefix, exactly what gen-mcp-index.mjs ships as promptName). A new skill fails conformance until its docs page, sidebar entry, and intro bullet exist.

Every skill also ships in the bestax plugin: scripts/gen-skills-repo.mjs copies each skill directory's tracked files into allxsmith/bestax-skills (root CLAUDE.md, "The bestax plugin"), so a new skill reaches it by construction. It takes its files from the same walk and vetting gate as the two syncs (vettedSkillFiles in scripts/lib/skills.mjs), so an untracked file or a symbolic link in a skill stops it too. It also refuses a hidden file inside a skill, and a non-image file of 256 KiB or more, because Anthropic's plugin directory does. Its README lists each skill with the first sentence of its description, read from bestax-mcp's index, so that sentence should stand on its own.

Outside the repo, several lists and directories name the skills or say how many there are, and some host copies. No check sees them. Adding, renaming or removing a skill means updating the listings that docs/docs/guides/distribution.md names under "What goes stale".

Rules

  • bestax-custom-component/references/component-catalog.md is generated — never hand-edit. Regenerate with pnpm gen:catalog; CI fails on staleness (gen:catalog:check).
  • Skills must track the library API: a component or helper-prop change that invalidates skill guidance updates the skill in the same PR (the anatomy rule in bulma-ui/CLAUDE.md ends with this step).
  • Skill docs state facts an agent can act on (props, valid values, copy-pasteable patterns) — when fixing a skill bug, fix the guidance that produced the bad output, not just the example.
  • jsx/tsx fences and the .tsx files in examples/ are linted with the ESLint plugin's recommended rules, in pnpm test (scripts/eslint-plugin-docs.test.mjs). A fence that is wrong on purpose takes nolint in its info string (```tsx nolint), and the marker fails once nothing in the fence is reported, which includes the fence no longer parsing. A migration "before" that imports from its own library needs no marker, because the rules follow the import rather than the tag name. An example that is not code at all belongs in a text fence.
  • Every .ts and .tsx file under skills/ is also type-checked with the compiler options of create-bestax's vite-ts template, in pnpm test (scripts/skill-examples-typecheck.test.mjs), because agents copy them into that scaffold and its build runs tsc first. Under its automatic JSX runtime and noUnusedLocals, a default import React that nothing reads fails that build, so import only what the file uses.
  • A skill's example points an image at a file the reader's app serves itself, never at a placeholder or stock-photo host, since an agent copies the URL into the user's app (check:conformance --only=image-hosts).
  • Storybook renders agent-generated showcases of these skills from bulma-ui/src/skill-examples/ — update those when a skill's canonical example changes.

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.