Handbook - Getting started

Verify The Repository

Use the narrowest check that proves the docs, examples, or implementation you changed. For docs-only changes, git diff --check and a link check are.

On this page

Use the narrowest check that proves the docs, examples, or implementation you changed. For docs-only changes, git diff --check and a link check are usually enough. For contract or code changes, run the relevant repo gates.

Default Verification

bun run verify

verify runs formatting check, typecheck, lint, Bun tests, contract checks, build, Go workspace tests, and backend coverage.

Full Local Verification

bun run verify:full

verify:full adds frontend smoke checks and git diff --check.

Focused Commands

PurposeCommand
Format checkbun run format:check
Typecheckbun run typecheck
Lintbun run lint
Bun testsbun run test
Contract drift checkbun run contracts:check
Backend coveragebun run coverage:backend
Frontend smokebun run smoke:frontend
Docker-backed local integrationbun run integration:local
Go workspace testsbun run go:test

Contract Check Rule

Run bun run contracts:check for any change touching:

  • GraphQL schema or operations;
  • AsyncAPI message bridge contracts;
  • generated UI contracts;
  • generated Go message contracts;
  • BFF bridge clients or adapters;
  • storage-read or storage-write message handling.

The check validates frontend GraphQL operations against the SDL, required GraphQL input fields against TypeScript UI contracts, and AsyncAPI request fields against Go structs.

Backend Coverage Targets

TypeScript BFF:

bun test --coverage apps/backend/src

Go backend services:

go test -tags surrealdb -coverprofile=/tmp/cloudgrid-go-backend.out \
  ./core/otlp-collector/... \
  ./core/control-plane/... \
  ./core/storage-read/... \
  ./core/storage-write/...

go tool cover -func=/tmp/cloudgrid-go-backend.out | tail -1

The backend coverage target is greater than 80 percent for the TypeScript BFF and the aggregate Go backend services.

Last updated .