docs(contributing): document the 2.0 module-train versioning and 1.x branch model#319
Merged
Merged
Conversation
…branch model Capture two policies for the 2.0 line: - Lockstep versioning (the "module train"): all published graph-compose* modules share one version and move together — a fix bumps the whole train by a patch, a feature by a minor; fonts/emoji keep their independent lines. release-process.md gains a 2.F section; the module-migration guide states the one-version rule up front. - Branch model: 2.0 work lives on 2.0-dev until GA; at GA main becomes the stable 2.0 line, develop the 2.x working branch, and a 1.x maintenance branch is cut from the final 1.9.x commit for critical / security fixes only (released as 1.9.x).
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.
Why
Two 2.0 policies weren't written down anywhere: how the multi-module version numbers relate, and what happens to 1.x once 2.0 becomes
main. This documents both so contributors and consumers have a single answer.What
docs/contributing/release-process.md→ new §2.F "The 2.0 module train" — the lockstep rule (all publishedgraph-compose*modules share one version; a fix bumps the whole train by a patch, a feature by a minor), whatcut-release.ps1bumps in one pass, thefonts/emojiindependent-version exception, and hyphenated-tag (beta) semantics.CONTRIBUTING.md→ new "Version lines and the 1.x maintenance branch" — the transitional model (2.0 work on2.0-dev;develop/mainare the 1.9.x line) and the post-GA model (main= stable 2.0,develop= 2.x working, a1.xbranch cut from the final 1.9.x commit for critical / security fixes only, released as 1.9.x).docs/migration/v2.0.0-modules.md— states the one-version rule up front in the TL;DR.The version bump targets and branch topology in the text were verified against
scripts/cut-release.ps1and the actualmain/develop/2.0-devstate.Tests
Docs-only.
CanonicalSurfaceGuardTest(scansCONTRIBUTING.md+docs/**for retired legacy tokens): 8 tests, 0 failures. New internal anchor resolves.