2 min readCalm pace · scan the outline anytime

Core and contract versioning

SemVer policy for Core 1.0.0-draft, docs URL /v1, and breaking changes to façades and events.

Core and contract versioning

This site is the sole architecture canon. Versioning keeps adopters aligned when rules or contracts change.

Version surfaces

SurfaceCurrentMeaning
Core badge1.0.0-draftNormative Modular Hexagonal DDD rules on this site
Docs URL/v1/...Major docs generation; breaking IA/rule sets may open /v2
Optional assistant packSame as Core badge when usedConvenience slice only — not a Core MUST
Published contractsPer event / façadeschemaVersion on events; additive methods on façades

SemVer for Core (when leaving draft)

BumpWhen
MAJORNormative MUST rules change in a breaking way (e.g. forbidding a previously allowed bridge)
MINORNew pages, new recommended practices, new MUST that does not invalidate correct existing modules
PATCHClarifications, typos, diagram fixes, non-normative examples

While the badge ends in -draft, treat all normative pages as evolving; adopters should pin a git commit or tag of this docs repo, not only the badge string.

Contract evolution (modules)

ChangeApproach
Add optional event fieldMINOR / additive — bump schemaVersion if consumers must notice
Remove or rename event fieldNew event type or major schemaVersion + dual-publish window
Add façade methodAdditive — OK
Change façade method meaningNew method; deprecate old
Replace in-process façade with HTTPConsumer ACL adapter only — Application/Domain unchanged

Adopter checklist

  1. Link architecture docs to this site (or a pinned mirror).
  2. Version your own Domain Events with schemaVersion + eventId.
  3. Record host adapter version separately (adapter pages may advance without a Core major).
  4. Optionally keep an assistant pack in sync if your team uses AI tools — never required for compliance.

Compatibility promise (draft)

Until 1.0.0 (non-draft):

  • Greenfield example names stay Ordering, Warehouse, Directory, Identity.
  • Core remains framework-agnostic (no host ORM / admin UI as Core MUST).
  • Breaking clarifications are logged in this repo’s ROADMAP.md decision log.

Next: Portable requirements · Adopt.

Modular Hexagonal Domain-Driven Design
Core 1.0.0-draft