agentleFS
Sign inStart free
Microsoft AzureKnown publisherAzure/containerization-assist/AGENTS.md

containerization-assist

AGENTS.md43 starsChanged 5 months agoMITView on GitHub

Instructions for AI coding agents working on this repository. This project produces two build targets (ESM and CJS) with different TypeScript configs. The local npm run typecheck only checks the ESM build (tsconfig.json). CI also builds CJS (tsconfig.cjs.json with "module": "commonjs"), which has different constraints (e.g. import.meta is not allowed). Always verify both builds pass before pushing: This runs: clean -> build:version -> build:knowledge -> build:policies -> build:esm -> build:cjs If a full build is too slow, at minimum check…

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

The file

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

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

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If a full build is too slow, at minimum check both TypeScript compilations:

    line 20
  2. Very specific:

    Run npm run build:version to generate the version file.

    line 33

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

Agent Instructions

Instructions for AI coding agents working on this repository.

Build Verification Before Pushing

This project produces two build targets (ESM and CJS) with different TypeScript configs. The local npm run typecheck only checks the ESM build (tsconfig.json). CI also builds CJS (tsconfig.cjs.json with "module": "commonjs"), which has different constraints (e.g. import.meta is not allowed).

Always verify both builds pass before pushing:

npm run build

This runs: clean -> build:version -> build:knowledge -> build:policies -> build:esm -> build:cjs

If a full build is too slow, at minimum check both TypeScript compilations:

npm run build:version && npm run build:knowledge && npx tsc -p tsconfig.json --noEmit && npx tsc -p tsconfig.cjs.json --noEmit

Common pitfalls

  • import.meta compiles under ESM (tsconfig.json, "module": "ES2022") but fails under CJS (tsconfig.cjs.json, "module": "commonjs"). Avoid it in src/ code.
  • __dirname / require() work in CJS but are not available at ESM runtime.
  • Generated files (src/lib/generated-version.ts, src/knowledge/embedded-packs.ts) are gitignored and created by build steps. They must exist before typecheck or tests. Run npm run build:version to generate the version file.

Running Tests

npm test                # unit + integration + e2e (auto-runs build:version)
npm run test:unit       # unit tests only

Code Style

  • TypeScript strict mode is enabled
  • Formatting: Prettier (npm run format:check)
  • Linting: ESLint (npm run lint)

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.

Check your setup, free