Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 2.82 KB

stability.md

File metadata and controls

49 lines (40 loc) · 2.82 KB

Stability criteria

RefMint 1.0.0 is the first stable release, with a public API contract. Pin the reviewed version and keep the existing identifier and search path available. The criteria below remain release gates; the 1.0.0 receipt records its checks.

The existing-ID v1 wire contract freezes its layout, canonical encoding and accepted presentation forms. Incompatible wire changes require a new version and reader. This is not a promise that the API, error diagnostics, supported environments or support policy will never change. Applications must retain the readers needed for references they have already issued.

API and compatibility verification

The 1.0 API contract defines the stable surface. pnpm test:package now compares its exact archive with integrity-pinned alpha.3 and beta.2 in both directions, including TypeScript consumers and historical Billetsys codes. See upgrade and rollback checks. The 1.0.0 release also defines support and release channels, including qualification of an existing final archive. Publication is verified; consumer acceptance and rollout remain separate.

Criteria before a stable release

  • Review and freeze the public API and error behavior; document any migration from alpha with examples, including rejected input and exact integer handling.
  • Verify released-format compatibility against the retained frozen vectors and an independent implementation; never update old vectors to conceal incompatibility.
  • Verify the exact package archive in supported Node/browser environments, including TypeScript consumers, and record its source identity and checksums.
  • Resolve known correctness/security blockers and document remaining limits, versioning, deprecation and maintenance policies.
  • Review consumer feedback and document concrete supported uses, integration cost and an exit/migration path. Any claim of faster entry or fewer human mistakes additionally requires human evidence with its method and limitations published.

These gates continue to apply to future releases. The synthetic tests and release records cover only their named properties, environments and versions. A stable API could be useful without a speed advantage; conversely, a faster single-person trial would not establish API stability.

Stability is not an adoption requirement by itself

A stable release can remove a prerelease-policy obstacle. It cannot create a manual-entry problem where existing IDs and search already work. Adoption remains a separate product decision, including the dependency and operational costs in the decision guide. Do not reopen declined integrations just because the version label changes.