Repository navigation
docs: the protocol version follows releases, not changes - #592
Merged
Merged
Conversation
Principle 9: PROTOCOL_VERSION is bumped once per release whose wire differs from the previous release's, when the release is cut, never in the pull request that changes the wire. Between releases main may change the wire under the same number; a change notes itself above the constant and the release folds the notes into one line.
Tryanks
enabled auto-merge (squash)
October 6, 2026 04:07
The template gains a checkbox for a wire change, which records a note under Unreleased above PROTOCOL_VERSION; the number changes at release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds principle 9 to CONTRIBUTING.md:
PROTOCOL_VERSIONis bumped once per release whose wire differs from the previous release's, when the release is cut, never in the PR that changes the wire. Between releasesmainmay change the wire under the same number; a wire change adds a note under "Unreleased" above the constant and cutting the release folds the notes into that version's line. The constant stays 9; the comment above it now states the rule and carries an empty Unreleased section. Maintainer-approved wording.