Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (19 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.2 KB

Contributing

Development setup

  1. Clone the repo and follow the README Quickstart.
  2. Ensure you have the prerequisites: Node (LTS), pnpm, Go 1.22+, Docker and Docker Compose.
  3. Run make bootstrap (or scripts/bootstrap.sh) then make up to start local services.

Workflow

  • Create a branch from main for your change.
  • Make changes; run make test and pnpm -r lint (or equivalent) before pushing.
  • Open a pull request; fill in the PR template. Link any related issues.
  • After review, maintainers will merge. Prefer squash merge for a clean history.

Code style

  • TypeScript/Next (control-plane, web): ESLint + Prettier. Run pnpm lint and pnpm format in each package.
  • Go (agent): gofmt; optionally golangci-lint. Follow existing patterns in the repo.
  • Docs: Markdown in docs/; keep commands copy-pasteable and accurate.

Commits

  • Use clear, imperative messages. Prefix with area when helpful: fix(control-plane): ..., docs: ....
  • Do not commit .env or real secrets. Use .env.example as a template.

Questions