You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,10 @@ backend:
12
12
description: This is the REST API for the ./frontend and ./cli clients.
13
13
deployment: https://chat.ruska.ai/docs
14
14
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).
17
19
- `make dev`Run dev server.
18
20
- `make seeds.user`Seed default users.
19
21
frontend:
@@ -56,13 +58,15 @@ The main way external AI Agents find out information about RUSKA will be from th
56
58
- `frontend/src`hosts the Vite/React client (`components`, `pages`, `routes`, `tests`), while `docs/`, `deployment/`, and `docker/` hold reference material and ops tooling.
57
59
58
60
## 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.
60
63
- 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.
61
64
- Infrastructure: `docker compose up postgres pgadmin`provisions Postgres + PgAdmin; stop with `docker compose down`.
62
65
63
66
## 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`.
66
70
67
71
## Testing Guidelines
68
72
- 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
72
76
## Commit & Pull Request Guidelines
73
77
- Sign every commit with `git commit -s ...`; keep subject lines imperative and reference issues or tickets when helpful.
74
78
- 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.
76
80
77
81
## Security & Configuration Tips
78
82
- EXTREMELY IMPORTANT: NEVER read a .env* file in your exploration.
0 commit comments