Summary
Add a CONTRIBUTING.md at the repo root to help new contributors get started quickly.
What to include
- Dev setup —
cd apps/backend && uv sync, frontend npm install, environment config
- Repo structure — brief map of
apps/backend, apps/frontend, apps/documentation, deployment/
- How to add a tool — register in
ALL_TOOLS in apps/backend/src/agent/core.py, type hints required
- How to add a skill — drop a
SKILL.md into apps/backend/src/skills/<name>/SKILL.md
- How to add a migration — new numbered file in
apps/backend/migrations/, append-only
- Running tests —
cd apps/backend && uv run pytest (or make test)
- Linting —
make lint / make lint-fix (ruff, line-length 100)
- PR checklist — tests pass, ruff clean, CLAUDE.md updated if behavior changed
- Code style rules — type hints everywhere, tools return dict never raise, no shell=True, loguru not print
Summary
Add a
CONTRIBUTING.mdat the repo root to help new contributors get started quickly.What to include
cd apps/backend && uv sync, frontendnpm install, environment configapps/backend,apps/frontend,apps/documentation,deployment/ALL_TOOLSinapps/backend/src/agent/core.py, type hints requiredSKILL.mdintoapps/backend/src/skills/<name>/SKILL.mdapps/backend/migrations/, append-onlycd apps/backend && uv run pytest(ormake test)make lint/make lint-fix(ruff, line-length 100)