ronce-racine
AGENTS.md9 starsChanged 23 days agoMITView on GitHub
Doc aimed at an agent (LLM) that works on this repo or uses it to equip another project. For the conceptual detail, see docs/architecture.md. Canonical source of generic Claude Code config (project-agnostic), installable in any repository: rules/ (always-on, by paths) · skills/ (on-demand workflows) · hooks/ (settings.json scripts - granular, one hook per .ts file) · agents/ (subagents) · scripts/ (executable detections). CLI: install.ts is the single tool (all families; rules-only via --rules-only). Hook composition: several plugins observe the same…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository59 other files it gives its agents.
- adversarial-feature-challengeSkill
- api-contract-versioningSkill
- bug-ticket-root-causeSkill
- bug-triage-structuredSkill
- ci-pipeline-orchestrationSkill
- commit-readiness-reviewSkill
- comprehensive-test-strategySkill
- database-schema-evolutionSkill
- ddd-backend-implementationSkill
- design-system-component-lifecycleSkill
- detection-sweepSkill
- domain-glossarySkill
- domain-modeling-designSkill
- frontend-fullstack-implementationSkill
- frontend-spec-call-site-auditSkill
- merge-request-reviewSkill
- performance-profilingSkill
- recording-decisionsSkill
- recurring-bug-root-causeSkill
- refactoring-shared-component-apiSkill
- validating-features-end-to-endSkill
- visual-regression-checkSkill
- writing-robust-testsSkill
- adversarial-feature-challengeSkill
- api-contract-versioningSkill
- audit-architectureSkill
- audit-ci-cdSkill
- audit-complianceSkill
- audit-industrialisationSkill
- audit-observabilitySkill
- audit-performance-frontendSkill
- audit-qualitySkill
- audit-reportSkill
- audit-securitySkill
- audit-testingSkill
- bug-ticket-root-causeSkill
- bug-triage-structuredSkill
- ci-pipeline-orchestrationSkill
- commit-readiness-reviewSkill
- comprehensive-test-strategySkill
- daily-workflow-optimizationSkill
- database-schema-evolutionSkill
- ddd-backend-implementationSkill
- design-system-component-lifecycleSkill
- detection-sweepSkill
- domain-glossarySkill
- domain-modeling-designSkill
- frontend-fullstack-implementationSkill
- frontend-spec-call-site-auditSkill
- merge-request-reviewSkill
- performance-profilingSkill
- production-incident-diagnosticSkill
- qa-session-intakeSkill
- recording-decisionsSkill
- recurring-bug-root-causeSkill
- refactoring-shared-component-apiSkill
- validating-features-end-to-endSkill
- visual-regression-checkSkill
- writing-robust-testsSkill
The file
We split this AGENTS.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
- Very specific: line 59
Read docs/writing-a-skill.md (contract) + docs/templates/SKILL.template.md (model).
- Very specific: line 97
Do not summarize a skill's workflow in its description (the agent would follow the summary instead of the skill).
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.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.
Files
Agent guide - Ronce Racine
Doc aimed at an agent (LLM) that works on this repo or uses it to equip another project. For the conceptual detail, see docs/architecture.md.
What this repo is
Canonical source of generic Claude Code config (project-agnostic), installable in any repository:
rules/ (always-on, by paths) · skills/ (on-demand workflows) · hooks/ (settings.json scripts - granular, one hook per .ts file) · agents/ (subagents) · scripts/ (executable detections). CLI: install.ts is the single tool (all families; rules-only via --rules-only).
Hook composition: several plugins observe the same event and PreToolUse updatedInput is last-wins. A hook that rewrites a command MUST keep the original readable (trailing shell comment), must not rewrite when the rewrite buys nothing, and must never mask an exit code through a pipe. See hooks/README.md.
Non-negotiable rules
- Genericity: an artifact here contains no project coupling (crate/script/path name, imposed tracker, imposed stack). If useful but coupled → split: the generic principle here, the tooling in the project repo. A precedence note ("if this repo has a specific X skill, it wins") is expected, and states what the project variant knows that this one cannot - without naming an example project.
- Language: English (code identifiers may remain as-is). Correct accents, "siliceum" always lowercase.
- Commits:
type(scope): descriptionformat (feat|fix|refactor|test|docs|chore), 1st line ≤ 72 chars, never mention Claude/AI/LLM. Ask for confirmation before any commit. - Pre-commit validation:
npm testmust be green (see Harness).
Using this repo on another project
npx ronce-racine plan <repo> # detects the stack, PROPOSES (read-only)
npx ronce-racine install <repo> [--all] # copies relevant rules/skills/hooks/agents + lockfile
npx ronce-racine install <repo> --yes # no selector: the pre-checked set (CI, non-TTY)
npx ronce-racine install <repo> --pick <kind:name...> # exactly these tokens, nothing else
npx ronce-racine check <repo> [--strict] # drift vs canonical (soft, or blocking)
npx ronce-racine detach <repo> <kind:name> # excludes a customized artifact from control
npx ronce-racine uninstall <repo> [--dry-run] # removes what the lockfile records, and only thatDetail: docs/adopting-a-repo.md. The lockfile <repo>/.claude/.ronce-racine.json tracks what is managed + the source package version and content hash.
Adding / modifying a hook
Hooks live in hooks/: one .ts file per logical hook. Each file must carry in its header JSDoc:
* @version X.Y.Z (semver)
* @last-reviewed YYYY-MM-DDThe tools/skills.ts hooks harness checks these two fields on every npm test. Available wirings per hook:
| Hook | Event | Matcher |
skill-reminder.ts | UserPromptSubmit | none |
bash-npm-silent.ts | PreToolUse | Bash |
truncate-output.ts | PreToolUse | Bash |
session-writer.ts | Stop | none |
session-inject.ts | SessionStart | compact |
session-precompact.ts | PreCompact | none |
worktree-env-setup.ts | SessionStart | none |
readme-freshness.ts | PreToolUse | Bash |
The install.ts installer merges the hook wirings for the selected hooks into <repo>/.claude/settings.json (deep-merge by event + matcher, idempotent, writes a settings.json.bak backup, preserves unrelated settings).
Modifying / adding a skill
- Read
docs/writing-a-skill.md(contract) +docs/templates/SKILL.template.md(model). - The skill must be generic, follow the standard sections, and have a
name+descriptionfrontmatter ("Use when …", third person, describes WHEN not HOW) +version(semver) +metadata.last-reviewed+category. - Body < 500 lines; beyond that → progressive disclosure (
reference/*.md). Runnable detection →scripts/*.ts(never.sh). Output template →templates/. - Bump
version+last-reviewed, add a line to the## Changelog. npm testgreen, then updatedocs/catalog.md(the README has no per-skill table).
Modifying / adding a rule
- Read
docs/writing-a-rule.md+docs/templates/rule.template.md. - Frontmatter:
paths(globs; omit = always-on) +version+metadata.last-reviewed. Body: imperative, short bullets, no magic numbers. npm testgreen + the rules table inREADME.md.
Harness (npm test)
The exact chain is package.json's test script - read it there rather than from a list that goes stale. It runs the tools/skills.ts subcommands (validate, triggers, routing, rules, scripts, hooks, agents, templates, docs), then tools/eval-lint.ts, tools/portability.ts, and finally vitest run. All must pass. Highlights:
validate- frontmatter, version, sections,reference//scripts//templates/links, depth ≤ 1.triggers/routing- routing discriminability (each quoted trigger classifies its skill in the top-3; each routing case beats the neighbours it declares).hooks- presence and validity of@version(semver) and@last-reviewed(ISO date) in eachhooks/*.ts.docs- documented claims checked against what the installer actually does.eval-lint- a gate whose literal its own prompt hands over.
Useful commands: npm run skills:list, npm run skills:triggers, npm run rules:validate, npm run typecheck.
Layout
rules/ skills/<name>/SKILL.md (+ reference/ scripts/ templates/)
hooks/ agents/ scripts/
install.ts (user-facing CLI, at the root: commands + argument parsing)
src/ (the CLI split up: paths, lock, catalog, detect, settings, selector, uninstall)
tools/ (internal harnesses, all via tsx: skills.ts, mutations.ts, portability.ts,
build.ts, and the eval family: eval.ts, eval-tasks.ts, eval-grade.ts,
eval-judge.ts, eval-report.ts, eval-lint.ts)
docs/ templates/ README.md AGENTS.mdCommon pitfalls
- Do not summarize a skill's workflow in its
description(the agent would follow the summary instead of the skill). - In a SKILL.md, only reference existing
reference//scripts//templates/files (the harness checks). - No
.sh: every script/hook is.tsrun bytsx. - Any discipline still coupled (RLS, compiled queries, conventions of a specific framework) stays on the project side, not here.
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
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.

