Skip to content

Commit f977a3e

Browse files
committed
Update AGENTS.md
1 parent 305fd31 commit f977a3e

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ backend:
1212
description: This is the REST API for the ./frontend and ./cli clients.
1313
deployment: https://chat.ruska.ai/docs
1414
commands:
15-
- `make test` Run ALL test cases.
16-
- `make format` Format project files. Use after making changes.
15+
- `make test` Run ALL test cases (uses ENV_FILE=~/.env/orchestra/.env.backend).
16+
- `make test ENV_FILE=~/.env/orchestra/.env.backend.test` Run tests with test env.
17+
- `make format` Format project files with ruff. Use after making changes.
18+
- `make lint` Lint check with ruff (no auto-fix).
1719
- `make dev` Run dev server.
1820
- `make seeds.user` Seed default users.
1921
frontend:
@@ -56,13 +58,15 @@ The main way external AI Agents find out information about RUSKA will be from th
5658
- `frontend/src` hosts the Vite/React client (`components`, `pages`, `routes`, `tests`), while `docs/`, `deployment/`, and `docker/` hold reference material and ops tooling.
5759

5860
## Build, Test, and Development Commands
59-
- Backend: `uv venv && source .venv/bin/activate && uv sync` installs dependencies, `bash backend/scripts/dev.sh` runs the API with reload, and `uv run pytest` (or `bash backend/scripts/test.sh`) executes the suite.
61+
- **Setup**: Run `make setup` from the repo root to install pre-commit hooks.
62+
- Backend: `cd backend && uv venv && source .venv/bin/activate && uv sync` installs dependencies, `make dev` runs the API with reload, and `make test` executes the suite. Use `ENV_FILE=~/.env/orchestra/.env.backend.test` for the test environment.
6063
- Frontend: `cd frontend && npm install`, `npm run dev` for local dev, `npm run build` for production bundles, and `npm run docs` regenerates MkDocs API docs.
6164
- Infrastructure: `docker compose up postgres pgadmin` provisions Postgres + PgAdmin; stop with `docker compose down`.
6265

6366
## Coding Style & Naming Conventions
64-
- Run `pre-commit run --all-files`; hooks call `make format` (Ruff) for Python and Prettier/ESLint for frontend changes.
65-
- Python modules use 4-space indents, `snake_case` files, and typed Pydantic models in `backend/src/schemas`. React code follows Prettier’s 2-space indent; components stay in `PascalCase`, hooks in `camelCase`.
67+
- Run `pre-commit run --all-files`; hooks run backend format/lint/test and frontend prettier/lint/test.
68+
- Python: ruff configured in `backend/pyproject.toml` with `line-length = 120`, select `["E", "F"]`. Per-file E402 ignores for files with `load_dotenv()` before imports. Use 4-space indents, `snake_case` files, typed Pydantic models in `backend/src/schemas`.
69+
- React: Prettier 2-space indent; components in `PascalCase`, hooks in `camelCase`.
6670

6771
## Testing Guidelines
6872
- Place backend unit specs in `backend/tests/unit` and integration cases in `backend/tests/integration`; seed demo data with `python -m seeds.user_seeder` when needed.
@@ -72,7 +76,7 @@ The main way external AI Agents find out information about RUSKA will be from th
7276
## Commit & Pull Request Guidelines
7377
- Sign every commit with `git commit -s ...`; keep subject lines imperative and reference issues or tickets when helpful.
7478
- Before opening a PR, ensure `uv run pytest`, `npm run test`, and any affected docs or `.env` samples reflect your changes; squash WIP noise locally.
75-
- PRs target `main`, link tracking issues, provide concise change notes, and include screenshots or API traces for UI-facing work.
79+
- PRs target `development`, link tracking issues, provide concise change notes, and include screenshots or API traces for UI-facing work.
7680

7781
## Security & Configuration Tips
7882
- EXTREMELY IMPORTANT: NEVER read a .env* file in your exploration.

0 commit comments

Comments
 (0)