agentleFS
MicrosoftKnown publishermicrosoft/ox-tools/crates/cargo-anvil/AGENTS.md

ox-tools / cargo-anvil

AGENTS.md28 starsChanged 11 days agoMITView on GitHub

- Keep reader documentation focused on supported behavior, configuration, failure recovery, and limitations. Every paragraph must help a reader use the tool or understand its contract. - Put contributor and agent instructions here, not in design prose or rustdoc. Keep user setup and configuration instructions in the reader documentation. - Do not duplicate source algorithms, API declarations, emitted workflows, or recipe bodies in prose. Use small examples only when they explain a choice the reader must make. - Document the…

  • Reads credentials
  • 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,439 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

12 rules. About 0 are common, 9 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep reader documentation focused on supported behavior, configuration, failure recovery, and limitations.

    line 5
  2. Distinctive:

    Put contributor and agent instructions here, not in design prose or rustdoc.

    line 8
  3. Distinctive:

    Keep user setup and configuration instructions in the reader documentation.

    line 9
  4. Distinctive:

    Do not duplicate source algorithms, API declarations, emitted workflows, or recipe bodies in prose.

    line 10
  5. Distinctive:

    Document the current contract, not implementation history, speculative features, or compatibility promises inferred from incidental code …

    line 13
  6. Very specific:

    Keep src/lib.rs as the crate README source and regenerate with just anvil-readme --fix.

    line 19
  7. Very specific:

    Follow the root version-bump policy for catalog changes, then regenerate repository artifacts, snapshots, and .anvil.lock together.

    line 25
  8. Very specific:

    Keep the root-MSRV scanners in versions.just and tools.just aligned.

    line 27
  9. Distinctive:

    Keep check scope and tier routing consistent across local, GitHub, and ADO entry points.

    line 30
  10. Distinctive:

    Update PR-title patterns and allowed types at their shared source so validation and corrective diagnostics continue to agree.

    line 32
  11. Distinctive:

    Update backend publishers explicitly when adding advisory checks.

    line 34
  12. Distinctive:

    Use the generated Anvil recipes as required by the root instructions.

    line 41

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

cargo-anvil contributor instructions

Documentation

  • Keep reader documentation focused on supported behavior, configuration, failure recovery, and limitations. Every paragraph must help a reader use the tool or understand its contract.
  • Put contributor and agent instructions here, not in design prose or rustdoc. Keep user setup and configuration instructions in the reader documentation.
  • Do not duplicate source algorithms, API declarations, emitted workflows, or recipe bodies in prose. Use small examples only when they explain a choice the reader must make.
  • Document the current contract, not implementation history, speculative features, or compatibility promises inferred from incidental code paths. Preserve real refusal and data-preservation guarantees.
  • Distinguish the generated recipes' Rust/Cargo support floor (1.95) from this crate's build MSRV in the workspace manifest. Do not imply that a documented support limit is enforced unless the code enforces it.
  • Keep src/lib.rs as the crate README source and regenerate with just anvil-readme --fix. Do not hand-edit README.md.

Source ownership

  • Edit canonical templates under templates/, not their generated copies. Follow the root version-bump policy for catalog changes, then regenerate repository artifacts, snapshots, and .anvil.lock together.
  • Keep the root-MSRV scanners in versions.just and tools.just aligned. They run before Cargo metadata is available and must agree on accepted syntax and workspace-versus-package precedence.
  • Keep check scope and tier routing consistent across local, GitHub, and ADO entry points. Establish impact mode before Just evaluates dependencies.
  • Update PR-title patterns and allowed types at their shared source so validation and corrective diagnostics continue to agree.
  • Update backend publishers explicitly when adding advisory checks; a new report file alone does not publish a PR comment.
  • Review Miri exclusions at the narrowest applicable scope. Revalidate nightly-dependent protocols when changing pins.

Validation

  • Use the generated Anvil recipes as required by the root instructions. Select focused regressions for the changed contract; do not treat snapshot acceptance as proof that an emitted script executes correctly.
  • Integration targets declared with required-features = ["test-util"] need that feature enabled. It is internal test support, not a downstream API.
  • Inspect validator availability when using tests/schemas.rs; missing executables skip checks. Report skipped checks rather than claiming coverage.
  • For a Miri nightly update, validate the compile/run protocol with executable contracts, including package working directories, environment restoration, filters, and aggregate failures.
  • For backend changes, distinguish local rendering/schema evidence from a successful current-commit CI run. ADO compliance composition requires the target environment; GitHub dogfooding cannot establish it.
  • scripts/test-anvil-dogfood.ps1 -GitHubToken requires an explicitly supplied host GITHUB_TOKEN. Without the switch its container checks are unauthenticated. Do not obtain host GitHub CLI credentials for the script.

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.