doit / backend
AGENTS.md1 starsChanged 10 months agoApache-2.0View on GitHub
This file provides guidance to AI agents (Claude, Gemini, etc.) when working with code in this directory.
We split this AGENTS.md into the rules it gives an agent
5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
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
- Very specific: line 32
Use pydantic-settings for configuration.
- Very specific: line 33
Use SQLModel for database models.
- Very specific: line 34
Use async/await for I/O bound operations (though psycopg sync is currently configured, consider async if scaling).
- Distinctive: line 35
Follow TDD: Write tests before implementation.
- Very specific: line 36
Place business logic in services/, not in routes.
≈ “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.
Files
AGENTS.md
This file provides guidance to AI agents (Claude, Gemini, etc.) when working with code in this directory.
Environment
- Framework: FastAPI (Python 3.13+)
- ORM: SQLModel
- Database: PostgreSQL (Neon Serverless)
- Migrations: Alembic
- Package Manager: uv
Commands
- Run Server:
uv run uvicorn backend.main:app --reload - Run Tests:
uv run pytest - Format:
uv run ruff format . - Lint:
uv run ruff check . - Migrations:
- Create:
uv run alembic revision --autogenerate -m "message" - Apply:
uv run alembic upgrade head
- Create:
Structure
src/backend/- Main application coderoutes/- API Route definitionscore/- Configuration, Database, Securitymodels/- SQLModel entitiesservices/- Business logicmiddlewares/- Custom middlewares
tests/- Tests (Unit & Integration)migrations/- Database migration scripts managed by Alembic
Code Standards
- Use
pydantic-settingsfor configuration. - Use
SQLModelfor database models. - Use
async/awaitfor I/O bound operations (thoughpsycopgsync is currently configured, consider async if scaling). - Follow TDD: Write tests before implementation.
- Place business logic in
services/, not in routes.
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 repository26 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .claude/skills/vercel-react-best-practices/AGENTS.mdAGENTS.md
- doit-cli/AGENTS.mdAGENTS.md
- frontend/AGENTS.mdAGENTS.md
- backend/CLAUDE.mdCLAUDE.md
- CLAUDE.mdCLAUDE.md
- doit-cli/CLAUDE.mdCLAUDE.md
- frontend/CLAUDE.mdCLAUDE.md
- better-auth-best-practicesSkill
- containerize-appsSkill
- create-auth-skillSkill
- fastapi-backendSkill
- frontend-designSkill
- helm-chartsSkill
- kagentSkill
- kubectl-aiSkill
- kubernetes-deployment-validatorSkill
- kubernetes-essentialsSkill
- mcp-builderSkill
- minikubeSkill
- nextjs-16Skill
- shadcn-uiSkill
- skill-creatorSkill
- vercel-react-best-practicesSkill
- web-design-guidelinesSkill
- websocket-engineerSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.