Knowledge Portal · engineering documentation

Skip to content

Tutorial: Create a New Contract

Audience: Platform engineer
Time: ~45 minutes
Last updated: 2026-07-05


Outcome

A versioned public contract in packages/contracts.

Steps

  1. Write ADR if boundary impact
  2. Define interface in packages/contracts/src/Contracts/
  3. Methods return DTOs only
  4. Implement adapter in platform Infrastructure
  5. Register in consumer ServiceProvider
  6. Add architecture test for forbidden direct imports
  7. Update contracts-index.md

Breadcrumbs: Home → Tutorials → Create Contract

ZAIXOS Knowledge Portal — public engineering docs at /docs · Staff operations at /admin