Skip to content

[freeze] STABILITY.md: write the 1.0 promise (semver surface, crate tiers, on-disk format, MSRV, deprecation) #282

Description

@joeldsouzax

Problem

The freeze milestone lands API decisions, but nowhere is it written down what the freeze promises to a consumer. Bombay is about to become the first serious dependent (M2 adapter); external adopters follow via the B1 OSS funnel. Without a written policy, every future change negotiates "is this breaking?" from scratch, and adopters can't judge what pinning 1.x buys them.

Write STABILITY.md (or a rustdoc stability module) covering

Why pre-freeze

The act of writing it is an audit: every clause you can't write cleanly ("wait, IS the json feature additive yet?") points at an unfinished freeze card. Cheap to do now, impossible to retrofit honestly after adopters exist.

Acceptance

STABILITY.md merged, linked from README + CLAUDE.md; every open freeze card either conforms to it or has a comment saying which clause it changes.

From the 2026-07-05 cross-repo roadmap review (ROADMAP.md Phase 0).

Metadata

Metadata

Assignees

No one assigned

    Labels

    api-freezePre-1.0 API-freeze hardening (breaking-to-change-later)documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions