agentleFS
docxologydocxology/codomyrmex/src/AGENTS.md

codomyrmex / src

AGENTS.md10 starsChanged 38 days agoMITView on GitHub

src/codomyrmex/ is the installable package. Source changes must preserve module boundaries, public exports, MCP discovery, typing, tests, and source-adjacent documentation. - Read the nearest module AGENTS.md before editing. - Run GitNexus impact analysis before changing any function, class, or method. - Keep public API changes aligned with __init__.py, API_SPECIFICATION.md, MCP_TOOL_SPECIFICATION.md, PAI, security, tests, and changelog surfaces. - Use centralized logging and typed exceptions for shared runtime behavior. - Preserve MCP metadata and tool registration when refactoring handlers. - Use real…

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    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 nearest module AGENTS.md before editing.

    line 13
  2. Distinctive:

    Run GitNexus impact analysis before changing any function, class, or method.

    line 14
  3. Very specific:

    Keep public API changes aligned with __init__.py, API_SPECIFICATION.md, MCP_TOOL_SPECIFICATION.md, PAI, security, tests, and changelog …

    line 15
  4. Distinctive:

    Use centralized logging and typed exceptions for shared runtime behavior.

    line 17
  5. Distinctive:

    Use real components and temporary resources in tests.

    line 19
  6. Distinctive:

    Do not treat optional dependency discovery as permission to import expensive or conflicting native backends.

    line 21
  7. Distinctive:

    Do not run broad source-documentation generators during the active hand-pass freeze.

    line 23
  8. Distinctive:

    Keep submodule worktrees outside package-wide formatting or rewriting.

    line 25

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

Agent guidance for the source tree

Purpose

src/codomyrmex/ is the installable package. Source changes must preserve module boundaries, public exports, MCP discovery, typing, tests, and source-adjacent documentation.

Development Guidelines

  • Read the nearest module AGENTS.md before editing.
  • Run GitNexus impact analysis before changing any function, class, or method.
  • Keep public API changes aligned with __init__.py, API_SPECIFICATION.md, MCP_TOOL_SPECIFICATION.md, PAI, security, tests, and changelog surfaces.
  • Use centralized logging and typed exceptions for shared runtime behavior.
  • Preserve MCP metadata and tool registration when refactoring handlers.
  • Use real components and temporary resources in tests; follow the root zero-mock policy.
  • Do not treat optional dependency discovery as permission to import expensive or conflicting native backends.
  • Do not run broad source-documentation generators during the active hand-pass freeze.
  • Keep submodule worktrees outside package-wide formatting or rewriting.

Key Files

  • README.md — source-tree overview
  • SPEC.md — source-surface specification
  • codomyrmex/__init__.py — package exports and metadata
  • codomyrmex/AGENTS.md — package-level agent guidance

Validation

Select checks proportionate to the change, then run the package gate before handoff:

uv run --locked ruff check src tests
uv run --locked ruff format --check src tests
uv run --locked ty check --output-format concise src tests
uv run --locked pytest -q <relevant-test-path>
make test

make test enforces the configured 60% coverage floor. Plain pytest is the faster diagnostic path and does not prove coverage compliance.

Navigation

  • Source overview
  • Package overview
  • Package agent guidance
  • Repository architecture
  • Repository agent contract

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.