agentleFS
sean2077sean2077/skills/AGENTS.md

skills

AGENTS.md5 starsChanged 49 days agoMITView on GitHub

skills/ is the published catalog. .agents/skills/ is this repository's private harness; its skill-eval route is not a public install target. Edit canonical sources using the ownership map. Generate runtime payloads from scripts/workflow_runtime/ and scripts/p0_runtime/; update scaffold-owned copies through agent-scaffold upgrade. Run affected checks from development; .github/workflows/validate.yml defines CI. Add an Unreleased entry for user- or maintainer-visible changes. Use Conventional Commits without Co-Authored-By. Keep frontmatter strict-YAML compatible; quote scalars containing : . Published descriptions use one physical line within the 320-character…

  • 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,774 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 repository5 other files it gives its agents.

The file

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

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

  • 5

    Very specific

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

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

    Run affected checks from development.

    line 9
  2. Very specific:

    Keep frontmatter strict-YAML compatible.

    line 11
  3. Very specific:

    Never edit the primary worktree, including docs.

    line 38
  4. Distinctive:

    Before the matching work, read its generic guide.

    line 54
  5. Very specific:

    Do not hand-edit host projections or scaffold runtime (.agents/tools/, .agents/conventions/, .agents/relink-skills.sh, …

    line 69
  6. Very specific:

    Third-party skills: follow project-owned placement and installation policy.

    line 70

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

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Skills — Agent Contract

skills/ is the published catalog. .agents/skills/ is this repository's private harness; its skill-eval route is not a public install target.

Editing and verification

Edit canonical sources using the ownership map. Generate runtime payloads from scripts/workflow_runtime/ and scripts/p0_runtime/; update scaffold-owned copies through agent-scaffold upgrade.

Run affected checks from development; .github/workflows/validate.yml defines CI. Add an Unreleased entry for user- or maintainer-visible changes. Use Conventional Commits without Co-Authored-By.

Keep frontmatter strict-YAML compatible; quote scalars containing : . Published descriptions use one physical line within the 320-character routing budget. Installer examples use quoted globs and ./ for local skill directories. Project-scope skills remove from the catalog root can remove catalog files.

Skills target Linux, macOS, and Windows through Git Bash, with LF source and real symlinks where required. Distinguish format, installation, wiring, and behavior evidence in support claims.

References

TopicSource
Product surfaces and source/generated ownershipArchitecture
Commands, checks, and releasesDevelopment
Dated host and installer verificationCompatibility
Documentation ownership and freshnessDocumentation maintenance
Skill and control designHarness principles
Canonical project terminologyCONTEXT.md
Pending and historical release changesCHANGELOG.md
<!-- agent-scaffold:start (managed; edit outside) profile=default domains=docs,tools,testing,specs,terminology,git,release,environment -->

Agent Harness

.agents/ is the harness source; .claude/ and .codex/ hold generated projections. CLAUDE.md links to this contract.

Session and task context

Honor the user's session entry; prefer task-local implementation/review. Resolve the task checkout and revision; use its AGENTS.md chain, terminology, skills, and tool working directories. Pass peers its absolute path and review revision. A shell cd does not reload host instructions or permissions; resolve access or guidance conflicts explicitly.

Worktree-per-change (hard rule)

Never edit the primary worktree, including docs. Reuse an assigned linked worktree; otherwise, if the scaffold owns creation, run bash .agents/tools/worktree.sh new <name>.

Keep one lifecycle owner. done --dir <absolute-wt> merges, ff-only pushes, and removes the worktree; it requires explicit authorization and scaffold ownership, runs outside that worktree, and is not a PR/MR handoff. Leave externally managed worktrees to their owner instead of merging or cleaning them up. Bypass the trunk guard only with explicit user approval.

Release the owning shell/session's directory handle before removal; a child cd cannot release its Windows handle. If done reports cleanup pending (exit 3), release the handle and use cleanup --dir <absolute-wt> for the empty unregistered .worktrees/<name> residue.

Authority documents (hard rules)

AGENTS.md is the canonical repository-level Agent contract; read the applicable nested chain before acting. Keep it lean and current; route detail to project docs and nest only for real local differences. Repair durable guidance drift in the same change; follow higher-priority instructions and surface material disagreement instead of guessing. Interpret document status and freshness alongside repository evidence and user intent.

Project terminology (hard rule)

Every Agent, project skill, and subagent uses the declared glossary, else root CONTEXT-MAP.md, then CONTEXT.md; read only relevant contexts before using project terms. A term and each language equivalent are equally valid names for one concept — use whichever is clearest and do not force one language. Reserve avoided names for history or compatibility. Resolve durable term changes with evidence and owner intent; update the glossary in the same change. Adopt an existing glossary; add definitions as durable concepts are resolved.

Convention guides

Before the matching work, read its generic guide; project documentation and nested contracts win where they are more specific.

  • Documentation: .agents/conventions/docs.md
  • Commands and tools: .agents/conventions/tools.md
  • Tests: .agents/conventions/testing.md
  • Specifications and design records: .agents/conventions/specs.md
  • Glossary changes: .agents/conventions/terminology.md
  • Commits and delivery: .agents/conventions/git.md
  • Version bumps, tags, and publication: .agents/tools/release/README.md
  • Setup and shared environments: .agents/conventions/environment.md

Sources and projections

  • Edit skills in .agents/skills/, then run bash .agents/relink-skills.sh; commit source and symlinks.
  • Edit subagents in .agents/subagents/, then run python .agents/tools/generate-subagents.py; commit source and projections.
  • Do not hand-edit host projections or scaffold runtime (.agents/tools/**, .agents/conventions/**, .agents/relink-skills.sh, .agents/symlink-manager.py); use agent-scaffold upgrade, then agent-scaffold verify.
  • Third-party skills follow project-owned placement and installation policy; preserve unrelated entries.

For Codex, confirm project trust, agent discovery, and /hooks approval; re-review changed definitions. Restore symlink/hardlink targets with Git, not Claude checkpoints.

<!-- agent-scaffold:end -->

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.