Skip to content

docs: define explicit release and versioning policy in VERSIONING.md #42

Description

@Icahbod

The contract maintains internal version metadata (storage_version, result_schema_version, protocol version) and emits a release-hash artefact on v* tags, but there is no top-level document explaining when any of those versions changes, what triggers a breaking release versus an additive one, or what STORAGE_VERSION, RESULT_SCHEMA_VERSION, and PROTOCOL_VERSION mean relative to each other. Author docs/VERSIONING.md describing: (a) the three version axes and which contract APIs they affect, (b) the rules for bumping each one (e.g. STORAGE_VERSION increments only on breaking state changes; PROTOCOL_VERSION increments only on breaking cross-contract interfaces), and (c) the migration contract that consumers can rely on. Link the new file from README.md and CHANGELOG.md.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions