From 6fe7aaecf3512be85cb2ada54106d5cce8137f0e Mon Sep 17 00:00:00 2001 From: Abhimanyu Saharan Date: Sat, 7 Feb 2026 21:13:21 +0530 Subject: [PATCH 1/3] docs: add repository guidelines --- AGENTS.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..afabc98e --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,33 @@ +# Repository Guidelines + +## Project Structure & Module Organization +- `backend/`: FastAPI service. App code lives in `backend/app/` (routes in `backend/app/api/`, models in `backend/app/models/`, schemas in `backend/app/schemas/`, workers in `backend/app/workers/`). DB migrations are in `backend/alembic/` (generated files in `backend/alembic/versions/`). +- `frontend/`: Next.js app. Routes live in `frontend/src/app/`; shared UI in `frontend/src/components/`; utilities in `frontend/src/lib/`; generated API client in `frontend/src/api/generated/` (do not edit by hand). +- `templates/`: shared templates packaged into the backend image (used by gateway integrations). +- `docs/`: protocol/architecture notes (see `docs/openclaw_gateway_ws.md`). + +## Build, Test, and Development Commands +From repo root: +- `make setup`: install/sync backend + frontend dependencies. +- `make check`: CI-equivalent suite (lint, typecheck, tests/coverage, frontend build). +- `docker compose -f compose.yml --env-file .env up -d --build`: run full stack (includes Postgres + Redis). + +Fast local dev loop: +- `docker compose -f compose.yml --env-file .env up -d db redis` +- Backend: `cd backend && uv sync --extra dev && uv run uvicorn app.main:app --reload --port 8000` +- Frontend: `cd frontend && npm install && npm run dev` + +Other useful targets: `make backend-migrate` (alembic upgrade), `make api-gen` (regenerate TS client; backend must be running on `127.0.0.1:8000`). + +## Coding Style & Naming Conventions +- Python: Black + isort (line length 100), flake8 (`backend/.flake8`), mypy is strict (`backend/pyproject.toml`). Prefer `snake_case` for modules/functions. +- TypeScript/React: ESLint (Next.js config) + Prettier (`make frontend-format`). Prefer `PascalCase` components and `camelCase` vars; prefix intentionally-unused destructured props with `_` (see `frontend/eslint.config.mjs`). +- Optional: `pre-commit install` to run formatting/lint hooks on commit. + +## Testing Guidelines +- Backend: pytest in `backend/tests/` (files `test_*.py`); run `make backend-test` or `make backend-coverage` (writes `backend/coverage.xml`). +- Frontend: vitest + testing-library; prefer `*.test.ts(x)` near the code (example: `frontend/src/lib/backoff.test.ts`); run `make frontend-test` (writes `frontend/coverage/`). + +## Commit & Pull Request Guidelines +- Use Conventional Commits (seen in history): `feat: ...`, `fix: ...`, `docs: ...`, `chore: ...`, `refactor: ...` with optional scope like `feat(chat): ...`. +- PRs should include: what/why, how to test (ideally `make check`), linked issue (if any), and screenshots for UI changes. Never commit secrets; use `.env.example` files as templates. From f7c8c688fce9eef80a608aaed5b0d9d94488ea0a Mon Sep 17 00:00:00 2001 From: OpenClaw Docs Bot Date: Sat, 7 Feb 2026 15:42:09 +0000 Subject: [PATCH 2/3] docs: add active development note to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 68afb145..19c94797 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ Web UI + API for operating OpenClaw: managing boards, tasks, agents, approvals, and gateway connections. +## Active development + +OpenClaw Mission Control is under active development. Expect breaking changes and incomplete features as we iterate. + +- Use at your own risk for production workloads. +- We welcome **bug reports**, **feature requests**, and **PRs** — see GitHub Issues: https://github.com/abhi1693/openclaw-mission-control/issues + - **Frontend:** Next.js app (default http://localhost:3000) - **Backend:** FastAPI service (default http://localhost:8000) - **Data:** Postgres + Redis From b166559e57f925302bb46f08d16501eac0ee53e7 Mon Sep 17 00:00:00 2001 From: OpenClaw Docs Bot Date: Sat, 7 Feb 2026 15:43:26 +0000 Subject: [PATCH 3/3] docs: add CI badge to README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 19c94797..02844882 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # OpenClaw Mission Control +[![CI](https://github.com/abhi1693/openclaw-mission-control/actions/workflows/ci.yml/badge.svg)](https://github.com/abhi1693/openclaw-mission-control/actions/workflows/ci.yml) + + Web UI + API for operating OpenClaw: managing boards, tasks, agents, approvals, and gateway connections. ## Active development