agentleFS
0xSoftBoi0xSoftBoi/suwappubot/bot/CLAUDE.md

suwappubot / bot

CLAUDE.md4 starsChanged 3 months agoApache-2.0View on GitHub

Scope: Telegram/WhatsApp handlers (bot/handlers/), business logic (bot/services/), SQLAlchemy models (bot/models/), FastAPI app (api/), runtime migrations (database/db.py). - Import-time crashes are the #1 deploy killer. A def that uses await, or a bad import, crashes at boot, not at call time — and CI does not catch it. Before claiming done: python3 -c "import ast; ast.parse(open('<file>').read())" and check the import chain from bot/main.py. - Format with black --line-length=100 before pushing; CI fails on style. - New commands register in bot/main.py:add_handlers() —…

The file

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

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Format with black --line-length=100: before pushing; CI fails on style.

    line 11
  2. Very specific:

    Background services: start in api/main.py's lifespan.

    line 14

≈ “Common” is an estimate: at least 1 in 5 of the 28,029 CLAUDE.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
CLAUDE.md

bot/ + api/ — Python monolith rules

Scope: Telegram/WhatsApp handlers (bot/handlers/), business logic (bot/services/), SQLAlchemy models (bot/models/), FastAPI app (api/), runtime migrations (database/db.py).

  • Import-time crashes are the #1 deploy killer. A def that uses await, or a bad import, crashes at boot, not at call time — and CI does not catch it. Before claiming done: python3 -c "import ast; ast.parse(open('<file>').read())" and check the import chain from bot/main.py.
  • Format with black --line-length=100 before pushing; CI fails on style.
  • New commands register in bot/main.py:add_handlers() — a handler file alone is a dead button. Copy an existing handler as the template.
  • Background services start in api/main.py's lifespan; a service module that isn't started there never runs. See docs/architecture/OVERVIEW.md.
  • Schema changes go in database/db.py:_ensure_schema() — additive + idempotent only — AND the Drizzle schema in api-ts/src/db/schema/ (ADR 0003). Follow docs/development/migrations.md.
  • MONEY-PATH: swap_engine, wallet, hot_wallet, encryption/KMS, fee math, withdrawals, seasons/points. Tag diffs MONEY-PATH; link an ADR.
  • Settings live in bot/config/settings.py (pydantic-settings); only TELEGRAM_BOT_TOKEN and ENCRYPTION_KEY lack defaults.
  • Tests: pytest tests/ — give it a generous timeout; slow ≠ hung.

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.