diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000000..9b2390a741 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,15 @@ +# Agent guide + +Conventions for AI-assisted development in this repository. See [development.md](./development.md), [backend/README.md](./backend/README.md), and [frontend/README.md](./frontend/README.md) for full setup details. + +## Non-interactive commands + +Use these shell commands for CI-parity build and test (no prompts). Mirrors [.github/workflows/test-backend.yml](./.github/workflows/test-backend.yml) and lint hooks in [development.md](./development.md). + +```bash +docker compose up -d db mailcatcher +cd backend && uv run bash scripts/prestart.sh && uv run bash scripts/tests-start.sh +uv run prek run --all-files +``` + +Run `uv run prek run --all-files` from the repository root. Run the `docker compose` and `backend` steps from the repository root as well. diff --git a/README.md b/README.md index a9049b4779..e6d943e4b1 100644 --- a/README.md +++ b/README.md @@ -222,6 +222,8 @@ Deployment docs: [deployment.md](./deployment.md). General development docs: [development.md](./development.md). +Agent / CI-parity commands: [AGENTS.md](./AGENTS.md) (non-interactive build and test). + This includes using Docker Compose, custom local domains, `.env` configurations, etc. ## Release Notes