hig-doctor
AGENTS.md153 starsChanged 9 months agoMITView on GitHub
HIG Doctor combines open-source audit tooling with an attributed snapshot of Apple's Human Interface Guidelines. - Keep Apple-platform rules distinguishable from HIG-aligned cross-platform rules. - Preserve source URLs and attribution in every reference file. - Treat Apple's live HIG as canonical; drift detection proposes review and must not rewrite guidance automatically. - packages/core owns framework detection, the audit rule catalog, structural engines, and the audit pipeline. The CLI, MCP server, website, and demos must consume that package or generate from…
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 repository14 other files it gives its agents.
- hig-components-contentSkill
- hig-components-controlsSkill
- hig-components-dialogsSkill
- hig-components-layoutSkill
- hig-components-menusSkill
- hig-components-searchSkill
- hig-components-statusSkill
- hig-components-systemSkill
- hig-foundationsSkill
- hig-inputsSkill
- hig-patternsSkill
- hig-platformsSkill
- hig-project-contextSkill
- hig-technologiesSkill
The file
We split this AGENTS.md into the rules it gives an agent
7 rules. About 0 are common, 5 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
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
- Distinctive: line 6
Keep Apple-platform rules distinguishable from HIG-aligned cross-platform rules.
- Distinctive: line 8
Treat Apple's live HIG as canonical.
- Very specific: line 14
After an audit-engine or rule-catalog change, run bun run --cwd demos/remotion-hig-doctor generate-data and inspect the generated report …
- Distinctive: line 17
Add a focused fixture and test for every detection-rule behavior change.
- Distinctive: line 18
Keep file scanning bounded and preserve symlink, size, and recursion safeguards.
- Distinctive: line 19
Use Bun 1.4.3 and Node 24 through Mise.
- Very specific: line 20
Run bun run validate while iterating and bun run validate:full for release-facing changes.
≈ “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
HIG Doctor agent instructions
HIG Doctor combines open-source audit tooling with an attributed snapshot of Apple's Human Interface Guidelines.
- Keep Apple-platform rules distinguishable from HIG-aligned cross-platform rules.
- Preserve source URLs and attribution in every reference file.
- Treat Apple's live HIG as canonical; drift detection proposes review and must not rewrite guidance automatically.
packages/coreowns framework detection, the audit rule catalog, structural engines, and the audit pipeline. The CLI, MCP server, website, and demos must consume that package or generate from it; do not maintain copied audit engines or rule catalogs.- After an audit-engine or rule-catalog change, run
bun run --cwd demos/remotion-hig-doctor generate-dataand inspect the generated report diff before validation. - Add a focused fixture and test for every detection-rule behavior change.
- Keep file scanning bounded and preserve symlink, size, and recursion safeguards.
- Use Bun 1.4.3 and Node 24 through Mise.
- Run
bun run validatewhile iterating andbun run validate:fullfor release-facing changes.
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.