Skip to content

README.md

Latest commit

 

History

History
29 lines (23 loc) · 1.34 KB

README.md

File metadata and controls

29 lines (23 loc) · 1.34 KB
Raw

Specifications

Spec Status
OpenScion architecture Draft
OpenScion data model Draft
OpenScion API Draft

Specifications define what the system must do before implementation details take over. Create one for behavior that changes a public API, crosses module boundaries, introduces a durable data format, or has meaningful operational constraints.

Use a short kebab-case filename such as retry-policy.md. Each specification should contain:

  1. Status and owner — Draft, Accepted, Implemented, or Superseded.
  2. Problem — the user or system need, without prescribing a solution.
  3. Goals and non-goals — the exact boundary of the work.
  4. Proposed behavior — public API, inputs, outputs, errors, and examples.
  5. Invariants and constraints — properties every implementation must keep.
  6. Acceptance criteria — externally observable pass/fail conditions.
  7. Open questions — unresolved decisions that block acceptance.

After the specification is accepted, create a linked implementation plan in ../plans/. Keep code snippets small enough to clarify the contract; production code still belongs under src/.

See example-retry-policy.md for a complete sample.