agentleFS
Sign inStart free
NYTEMODEONLYNYTEMODEONLY/polyterm/AGENTS.md

polyterm

AGENTS.md356 starsChanged 7 months agoMITView on GitHub

These instructions apply to all work in this repository. Before finalizing substantial changes, verify:

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    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:

    Do not introduce monolithic files, modules, or command handlers.

    line 7
  2. Distinctive:

    Prefer small, focused modules with clear single responsibilities.

    line 8
  3. Distinctive:

    Keep features easy to edit, add, remove, and test in isolation.

    line 9
  4. Distinctive:

    When extending functionality, add or modify the smallest relevant module instead of expanding a central "god" file.

    line 12
  5. Distinctive:

    Before finalizing substantial changes, verify:

    line 16
  6. Very specific:

    Keep docs/README.md aligned with the command, TUI, API, core, database, and utility modules that exist in the repo.

    line 24
  7. Very specific:

    When adding or renaming a module under polyterm/cli/commands, polyterm/tui/screens, polyterm/api, polyterm/core, polyterm/db, or …

    line 25
  8. Distinctive:

    Do not leave generated placeholder docs in the published tree.

    line 26
  9. Very specific:

    Run ./test_all_commands.sh, .venv/bin/python scripts/validate_docs.py, and focused tests for touched modules before committing …

    line 29

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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

Project Agent Rules

These instructions apply to all work in this repository.

Architecture Rule: No Monoliths

  • Do not introduce monolithic files, modules, or command handlers.
  • Prefer small, focused modules with clear single responsibilities.
  • Keep features easy to edit, add, remove, and test in isolation.
  • Split large changes into composable units (API layer, core logic, CLI/TUI wiring, tests).
  • Favor explicit interfaces between modules over tightly coupled cross-module logic.
  • When extending functionality, add or modify the smallest relevant module instead of expanding a central "god" file.

Change Quality Gate

Before finalizing substantial changes, verify:

  • The code path can be understood without reading unrelated modules.
  • A future contributor can replace/remove a feature without broad refactors.
  • Tests are scoped to behavior of the touched module(s), not accidental implementation details.

Documentation Rule

  • Keep docs/README.md aligned with the command, TUI, API, core, database, and utility modules that exist in the repo.
  • When adding or renaming a module under polyterm/cli/commands, polyterm/tui/screens, polyterm/api, polyterm/core, polyterm/db, or polyterm/utils, add or update the matching page under docs/.
  • Do not leave generated placeholder docs in the published tree. Replace stubs with a clear overview, source path, data sources, verification notes, and related documentation links.
  • For API-facing changes, document the current Polymarket endpoint contract and identifier requirements. Be explicit about Gamma market IDs, Gamma slugs, CLOB condition IDs, and CLOB token IDs.
  • For CLI/TUI changes, document the exact command, shortcuts, options, output modes, and whether the workflow is view-only or can mutate local state.
  • Run ./test_all_commands.sh, .venv/bin/python scripts/validate_docs.py, and focused tests for touched modules before committing documentation-sensitive changes.

Download now (ZIP)

  • 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 28,693 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 repository2 other files it gives its agents.

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