docs: add release policy (#814)#818
Merged
Merged
Conversation
Codifies the two-part versioning scheme (vMAJOR.MINOR), the scope rules for patch, minor, and major releases, parallel maintenance for the previous major, and the referencing convention across versions. Resolves the thread on #814 so contributors and adopters have a single place to point to before proposing structural changes.
The original wording called patch fixes a release type, which conflicts with the two-part v<MAJOR>.<MINOR> scheme defined in RELEASE.md. Patch fixes ship in-branch without a separate version. Rewording makes that explicit and points readers at the actual scope rules.
Several spots still implied patches were a release type: - H2 "Scope Rules by Release Type" -> "Scope Rules by Change Type" - H3 "Patch (in-branch fixes...)" -> "Patch fix (in-branch...)" - Cadence bullet "Patch and minor releases ship..." rewritten so only minor releases are described as shipping - Parallel Maintenance bullet rewritten to say "minor releases and in-branch patch fixes" instead of "patch and minor updates" Also tightened a couple of unrelated nits: - "made on the active minor branch" was ambiguous between git branch and dev folder; changed to "applied directly to the in-progress minor" - Repository Layout block now mirrors the README example (1.0/ and 1.01-dev/) instead of inventing hypothetical 1.02-dev/ and 2.0-dev/ folders. The major-dev folder is mentioned in prose as a future pattern, not a current convention. - "appropriate for casual reference" -> "works for casual reference"
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
2 participants
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.
Summary
Closes the thread on #814 by writing down the AISVS release policy so contributors, adopters, auditors, and tooling vendors have a single source of truth.
RELEASE.mdcovering the two-part versioning scheme (v<MAJOR>.<MINOR>), the scope rules for patch, minor, and major releases, parallel maintenance for the previous major line, and the referencing convention.README.md(Versioning section) andCONTRIBUTING.md.v<version>-Cx.y.zreferencing convention encodes chapter and section identity.Notes
1.0/,1.01-dev/) and with thev1.0-C9.4.3citation format already documented in the README.Test plan
RELEASE.mdagainst the discussion in AISVS release practices #814 and confirm both Otto's original proposal and the strict-minor adjustment are reflected.RELEASE.mdagainst current folder names.