shadowclone / tooling
AGENTS.md25 starsChanged 32 days agoMITView on GitHub
The repository checks that bun run lint runs. They check conventions, package boundaries, privacy terms, bundled skills, prose, and package guides. (generated by bun run guides; do not edit by hand) Run bun test in this folder, or bun test tooling from the root. Tests build temporary trees with treeWith from src/boundaries/testing.ts. Each test fails when its rule is off. Update this file in the same commit when you change the package purpose, public exports, dependencies, or a rule above.
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,700 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 repository49 other files it gives its agents.
- AGENTS.mdAGENTS.md
- evals/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- evals/CLAUDE.mdCLAUDE.md
- tooling/CLAUDE.mdCLAUDE.md
- choose-by-consequenceSkill
- design-deep-modulesSkill
- diagnose-before-editingSkill
- plan-with-review-pageSkill
- research-primary-sourcesSkill
- resolve-conflicts-by-intentSkill
- scope-confirmed-changesSkill
- shadowclone-build-preferencesSkill
- shadowclone-reviewSkill
- shadowclone-workSkill
- tests-that-catch-bugsSkill
- typescript-type-safetySkill
- verify-and-reviewSkill
- write-plain-englishSkill
- choose-by-consequenceSkill
- data-handlingSkill
- design-deep-modulesSkill
- diagnose-before-editingSkill
- plan-with-review-pageSkill
- research-primary-sourcesSkill
- resolve-conflicts-by-intentSkill
- scope-confirmed-changesSkill
- shadowclone-build-preferencesSkill
- shadowclone-reviewSkill
- shadowclone-workSkill
- tests-that-catch-bugsSkill
- typescript-type-safetySkill
- verify-and-reviewSkill
- write-plain-englishSkill
- choose-by-consequenceSkill
- design-deep-modulesSkill
- diagnose-before-editingSkill
- guided-pr-reviewSkill
- plan-with-review-pageSkill
- research-primary-sourcesSkill
- resolve-conflicts-by-intentSkill
- scope-confirmed-changesSkill
- shadowclone-reviewSkill
- shadowclone-workSkill
- tests-that-catch-bugsSkill
- typescript-type-safetySkill
- verify-and-reviewSkill
- verify-review-findingsSkill
- write-plain-englishSkill
The file
We split this AGENTS.md into the rules it gives an agent
3 rules. About 0 are common, 2 are distinctive, and 1 is 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.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 30
Do not edit the checker script.
- Very specific: line 35
Run bun test in this folder, or bun test tooling from the root.
- Distinctive: line 37
Update this file in the same commit when you change the package purpose, public exports, dependencies, or a rule above.
≈ “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
@shadowclone/tooling
The repository checks that bun run lint runs. They check conventions, package boundaries, privacy terms, bundled skills, prose, and package guides.
<!-- package-facts:start -->(generated by bun run guides; do not edit by hand)
- Package name:
@shadowclone/tooling - Workspace dependencies:
@shadowclone/core,@shadowclone/skills - External dependencies:
prettier,typescript,zod - Export subpaths: none
<!-- package-facts:end -->Owns
src/conventions.ts: file length, no comments, and no dashes.src/boundaries.tsandsrc/boundaries/: the package graph inpackages.ts, import checks, and manifest checks.src/privacy.tsandsrc/skills.ts: privacy terms and bundled skill quality.src/releasePackages.ts: checks CLI and skill-content publication independently for partial-release retries.src/skillVersions.tsandsrc/releaseVersions.ts: recorded skill fingerprints and release versions.src/prose.tsandsrc/packageGuides.ts: Markdown prose and links, and the package guides.
Rules
- Each check is a script with an
import.meta.mainblock and a function that tests call. It exits with 1 on a finding. src/boundaries/packages.tsis the only package graph. Edit it, with a design record, before you add a dependency.src/prose/exclusions.tsholds every excluded path.src/prose/ste.tsrunsskills/write-plain-english/scripts/check-ste.mjs.- Do not edit the checker script. A recorded fingerprint covers it.
src/packageGuides.ts --writerewrites only the package-facts block of a guide.
Tests
Run bun test in this folder, or bun test tooling from the root. Tests build temporary trees with treeWith from src/boundaries/testing.ts. Each test fails when its rule is off.
Update this file in the same commit when you change the package purpose, public exports, dependencies, or a rule above.
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.