Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,15 @@ Built on `mongo-migrate-ts`. Migrations are TypeScript files with `up()` and `do
- Run: `pnpm migrate:up`, `pnpm migrate:down`, `pnpm migrate:status`
- Framework docs: [docs/architecture/db-migrations.md](docs/architecture/db-migrations.md)

## Code Readability

- Write for humans: descriptive names, small focused functions, simple control flow, minimal abstraction.
- Separate logical steps with blank lines; avoid dense one-liners and unrelated statements packed together.
- Give every non-trivial function and logical code block a short comment explaining what it does; add intent, assumptions, invariants, or surprising reasons where useful.
- Document function parameters, types, and their fields/properties with concise JSDoc/TSDoc explaining meaning, constraints, units, optionality, and defaults where relevant.
- Do not narrate trivial or self-evident code. Document public contracts and failure behavior when names and types are insufficient.
- Follow local conventions and formatters; review readability as well as correctness.

## Development

```bash
Expand Down
3 changes: 3 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@AGENTS.md

Keep this file as a loader only. Never add instructions here; put them in AGENTS.md.
Loading