Spec-First Contribution Workflow

SynckHub engineering is spec-first.

Workflow

  1. Identify the authoritative contract doc for your change.
  2. Update the contract when behavior changes.
  3. Implement minimal code changes matching the new contract.
  4. Verify with focused tests/checks.
  5. Ship docs and code together.

Why this is mandatory

If code and contract diverge, client integrations become guesswork and regressions hide behind “implementation details.”

Practical guardrails

  • avoid parallel undocumented endpoint behavior
  • preserve stable error taxonomy unless contract explicitly changes
  • call out authz/tenant/visibility semantics in every API-impacting change
Previous
Common API
Next
Guides