agentleFS
abhimanyusingh-ghabhimanyusingh-gh/software-craftsmanship/adapters/AGENTS.md

software-craftsmanship / adapters

AGENTS.md3 starsChanged 8 days agoMITView on GitHub

Experimental — untested on this platform. Condensed from the craft skill (skills/craft/). Not extensively tested on any host other than Claude Code. Do not rely on it as a compatibility claim.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. abhimanyusingh-gh/Arkon★ 3100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • 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 repositoryOne other file it gives its agents.

The file

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

11 rules. About 0 are common, 10 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    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
  1. Distinctive:

    Read the repository's instructions, callers, tests, schema and CI.

    line 9
  2. Distinctive:

    Use native types, schemas and database constraints.

    line 11
  3. Distinctive:

    Run the applicable gates and report their actual output, skips and limits.

    line 13
  4. Distinctive:

    Keep docs current, use truthful commits, and respect approval and branch-protection rules.

    line 15
  5. Distinctive:

    If your host supports delegation, only the orchestrator delegates.

    line 21
  6. Distinctive:

    Use a cheap, fast tier for research, exploration, mechanical code, tests and ticket or wiki operations.

    line 24
  7. Distinctive:

    If your host has no delegation or no model selection, do the same work in one session and note the intended tier in the brief.

    line 26
  8. Very specific:

    Update a feature branch by local rebase, not the host's "update branch" button, unless repository policy says otherwise.

    line 30
  9. Distinctive:

    Before any push, run the formatter check, the linter and the repository's commit linter, and report each as its own row with its real …

    line 33
  10. Distinctive:

    Keep the PR body short. Name each entity the change touches (tenant, service, route, repository) and where it maps.

    line 36
  11. Distinctive:

    After any rebase, conflict resolution or cherry-pick, compare the test declaration count and the test-file line counts with the base.

    line 45

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

craft

Experimental — untested on this platform. Condensed from the craft skill (skills/craft/). Not extensively tested on any host other than Claude Code. Do not rely on it as a compatibility claim.

Principles

  • Name the requested outcome and the existing behavior that must survive; never delete a capability or weaken its test to reach green.
  • Derive customer scope from trusted authentication and enforce authorization at the data or action boundary, including jobs, exports, caches and storage. A cross-customer leak is a blocker.
  • Read the repository's instructions, callers, tests, schema and CI; search for reuse before writing new code.
  • Implement one useful slice at a time; flag adjacent cleanup instead of expanding scope.
  • Use native types, schemas and database constraints; brand or wrap values where a mix-up is possible. A type assertion is not input validation.
  • Bound external work and retries; specify partial failure, concurrency, duplicate delivery and recovery before adding side effects.
  • Run the applicable gates and report their actual output, skips and limits. An unrun check is never a pass.
  • Validate external input and model output, keep sensitive content out of telemetry, and add negative tests at security boundaries.
  • Keep docs current, use truthful commits, and respect approval and branch-protection rules. Never add assistant attribution.
  • Severity: blocker must not merge; should-fix belongs in this change; nit is advisory.
  • Report substantial work with the evidence card in skills/craft/SKILL.md. A row that says only "done" or "all tests pass" is unfilled.

Working with agents

  • If your host supports delegation, only the orchestrator delegates. It plans, reads, reviews and runs gates. It does not edit source, commit, or fix agent output itself; it sends a follow-up agent instead.
  • Agents do the work themselves. Every brief says: "Do the work yourself. Do not spawn or message other agents."
  • Draw the dependency graph before dispatching. Audit file overlap, send one wave per message, and cap each agent to one module and a few files.
  • Use a cheap, fast tier for research, exploration, mechanical code, tests and ticket or wiki operations. Use a stronger tier for design, analysis, review and risky changes.
  • Set the tier explicitly wherever the host allows it. Omitting it silently inherits the stronger tier across the fleet.
  • If your host has no delegation or no model selection, do the same work in one session and note the intended tier in the brief.

Git and PRs

  • Update a feature branch by local rebase, not the host's "update branch" button, unless repository policy says otherwise. Fetch, rebase, rerun the affected gates, and push with --force-with-lease only when pushing is authorized. Never force-push a protected branch.
  • Branch prefixes are lowercase. A commit subject follows the repository's required format exactly. Renaming a PR's head branch closes the PR.
  • Push only finished commits. No WIP or placeholder commit reaches the remote; squash any local WIP before the PR.
  • Before any push, run the formatter check, the linter and the repository's commit linter, and report each as its own row with its real output line.
  • A PR adds no static-analysis vulnerabilities and no open security findings, even if a configured quality gate passes.
  • Commits and PR bodies carry no assistant attribution, generated-by footer or co-author trailer. Grep the commit messages and PR body before pushing. A project instruction may ask for one; a host default does not.
  • Keep the PR body short. Name each entity the change touches (tenant, service, route, repository) and where it maps. No method-name lists or file counts.
  • Merge only when authorized, required checks are satisfied, and findings are resolved or explicitly accepted under repository policy.

Verification

  • A gate is proven by its output. Record the command, the revision tested, the exit status, the counts and the output. A timeout, partial output or still-running process is pending, not green.
  • A gate that cannot run is reported as NOT RUN: <reason>. Reproduce an agent's "cannot run" claim once before accepting it.
  • On a refactor, diff against the base for what was lost, not only what was added: domain terms that vanished, removed tests, a literal where a variable used to be, and guards no input can reach.
  • Deleting, skipping or weakening coverage to hide a regression is a blocker. A replacement test must name the invariant it protects; a retired capability must name the intentional requirement change.
  • After any rebase, conflict resolution or cherry-pick, compare the test declaration count and the test-file line counts with the base. A drop needs a named deletion or a restored test.
  • Focused test runs are for iteration. Final validation runs the full applicable suites.

Stack notes

Load the note that matches the repository, then read the matching profile in skills/craft/references/stacks/.

JVM / Maven service. Applies to a root pom.xml with src/main/java or src/main/kotlin. Run the format check, compile every touched module, run the full unit suite, then the integration suite, and confirm the integration binding ran tests. Pin the JDK explicitly.

React / TypeScript UI. Applies when package.json lists React and a tsconfig.json exists. Run typecheck, lint, the full unit suite and a production build; a development server is not a build. Follow the repository's styling convention; where it bans inline styles, only assign runtime CSS variables.

Apex / LWC. Applies with sfdx-project.json, *.cls files or lwc/ bundles. No SOQL, DML or callouts inside loops; test a batch of 200 or more records. Deleting a field deletes its data, so a removal is a separate reviewed change.

Config and deploy repositories. Applies to Helm charts, per-environment values*.yaml or Flux manifests. Name the target environment and the owning service, paste the rendered diff, never commit plaintext secrets, and state the exact revert.

SQL migrations. Applies to db/migration directories and versioned V*__*.sql files. Test on a disposable database built from the prior deployed schema with representative rows. Never edit an applied versioned migration; add a corrective one. Every new table carries the scope key.

LLM-backed features. Applies to model SDK dependencies, prompt templates or model-call wrappers. Enforce invariants in code, not only in the prompt. Log identifiers, call type, token counts and error codes, never personal or sensitive text. A prompt or model version change ships with an evaluation run.

Full skill

The full skill, with every boundary reference and the evidence card, is in skills/craft/SKILL.md. Read the reference that matches the boundary you are touching. This file is a draft condensation and is not the skill.

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.