Stability Policy

ByteOr OSS follows a conservative pre-1.0 stability posture. Documented contracts matter even before a 1.0 release.

Stable Contracts

The following OSS contracts are the clearest current commitments:

  • byteor-abi repr(C) layouts and generated header workflow
  • byteor-pipeline-spec v1 data model
  • Deterministic KV encode/decode and canonicalization behavior
  • IndexBus v1 lane semantics and repr(C) layouts

Evolving Surfaces

These are useful today but still evolving:

  • Executor convenience helper APIs
  • SHM file naming/path conventions
  • Runtime bring-up helper shapes
  • Proc-macro ergonomics
  • xtask command surface and gate toggles

Versioning

  • SemVer with pre-1.0 convention
  • Breaking changes bump the minor version (0.Y.0)
  • Non-breaking additions bump the patch version (0.Y.Z)
  • Crates move in lockstep to avoid dependency skew

Experimental Features

New capabilities not ready for long-term support ship behind unstable- prefixed feature flags. These are explicitly outside the stability contract.

Canonical Published Surfaces

Provenance
Need the canonical source?
Use the public hub to orient yourself, then jump to repo-owned docs or rustdoc when you need contract-level detail.