Skip to content

Validate Changes

Run the smallest relevant suite first, then broaden when a change touches shared code, security boundaries, generated artifacts, or deployment behavior.

This policy is mandatory and is enforced during review:

  • Major new functionality MUST add automated tests covering that functionality, in the same change that introduces it.
  • Every bug fix MUST add a regression test that fails without the fix and passes with it.
  • Reviewers MUST confirm the required tests exist and run in CI before approving; pull requests that omit them are not merged.
CommandPurpose
pnpm run build:typescriptBuild TypeScript apps and packages.
pnpm run lintRun package linters where present.
pnpm run typecheckRun TypeScript type checks.
pnpm run testFull TypeScript, Go, and Python test suite.
pnpm run test:typescriptTypeScript app/package tests.
pnpm run test:goGo service/package and interoperability tests.
pnpm run test:pythonPython package tests.
pnpm run ciBuild, lint, typecheck, and test sequence.
pnpm docs:version:verifyValidate documentation version metadata and snapshot locks.
AreaCommand
Runtime CLIpnpm --dir apps/runtime test
Web consolepnpm --dir apps/web test
Web backend-for-frontendpnpm --dir apps/auth test
APIpnpm --dir apps/api test
Coordinatorpnpm --dir apps/coordinator test
STS, Gateway, Audit, Go packagespnpm run test:go (the repository harness owns its multi-module workspace)
Docspnpm --dir docs build
Docs versioning onlypnpm exec vitest run tests/typescript/unit/docs/versioning.test.ts

Runnable examples live in the Caracal examples repository and carry their own test suites and CI.

Terminal window
scripts/testCi.sh
scripts/testCi.sh --smoke
scripts/testCi.sh --go
scripts/testCi.sh --py
scripts/testCi.sh --ts
scripts/testCi.sh --docs

Use broader checks when a change affects auth, crypto, config, release, infra, shared packages, SDK contracts, or interoperability schemas.

Record the exact commands and results in the pull request. Do not claim the full suite when only targeted checks ran.

After validation, review Understand Governance for contribution scale, review ownership, and private security process.