agentleFS
broomvabroomva/skills/AGENTS.md

skills

AGENTS.md4 starsChanged 5 months agoMITView on GitHub

Replace placeholder text and keep this file compact, command-first, and operational. Run from repository root:

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

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

16 rules. About 0 are common, 12 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈12

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run from repository root:

    line 13
  2. Distinctive:

    Prefer deterministic scripts over interactive/manual steps.

    line 24
  3. Very specific:

    Keep command names stable (smoke, check, test, ci).

    line 25
  4. Distinctive:

    Update docs and scripts in the same change when workflow behavior changes.

    line 26
  5. Distinctive:

    Avoid side effects outside the repo unless explicitly required.

    line 27
  6. Distinctive:

    Keep internal data models typed and normalized.

    line 32
  7. Distinctive:

    Keep each module focused on one responsibility.

    line 33
  8. Very specific:

    Document boundary ownership in docs/ARCHITECTURE.md.

    line 34
  9. Distinctive:

    Keep event fields stable for querying and alerting.

    line 40
  10. Distinctive:

    Update status checkpoints during execution and after major decisions.

    line 47
  11. Very specific:

    Run make check before make test.

    line 51
  12. Very specific:

    Run make ci before pushing large refactors.

    line 52
  13. Distinctive:

    Treat lint/type failures as blocking.

    line 53
  14. Distinctive:

    Remove stale scripts/docs quickly.

    line 57
  15. Distinctive:

    Keep templates and real workflows in sync.

    line 58
  16. Distinctive:

    Run periodic harness audits:

    line 59

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

AGENTS.md

Replace placeholder text and keep this file compact, command-first, and operational.

Project Overview

  • Project: <project-name>
  • Primary runtime(s): <runtime>
  • Main entrypoint(s): <entrypoints>

Harness Commands

Run from repository root:

GoalCommand
Fast sanity checkmake smoke
Static checksmake check
Full test suitemake test
CI-equivalent local runmake ci

Constraints And Guardrails

  • Prefer deterministic scripts over interactive/manual steps.
  • Keep command names stable (smoke, check, test, ci).
  • Update docs and scripts in the same change when workflow behavior changes.
  • Avoid side effects outside the repo unless explicitly required.

Architecture Boundaries

  • Parse and validate external data at boundaries.
  • Keep internal data models typed and normalized.
  • Keep each module focused on one responsibility.
  • Document boundary ownership in docs/ARCHITECTURE.md.

Observability Expectations

  • Include trace_id and run_id in long-running workflow logs.
  • Emit structured event names for major transitions (start, step, success, failure).
  • Keep event fields stable for querying and alerting.
  • Maintain field definitions in docs/OBSERVABILITY.md.

Execution Plans

  • For tasks expected to exceed ~30 minutes, create/update PLANS.md before coding.
  • Track scope, constraints, milestones, and verification steps.
  • Update status checkpoints during execution and after major decisions.

Static Analysis And Quality Gates

  • Run make check before make test.
  • Run make ci before pushing large refactors.
  • Treat lint/type failures as blocking.

Entropy Management

  • Remove stale scripts/docs quickly.
  • Keep templates and real workflows in sync.
  • Run periodic harness audits:
    • scripts/audit_harness.sh .

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.