docs: align CONTRIBUTING/README/roadmap with CalVer + dual-pace channels (ADR-0004) - #317
Merged
Merged
Conversation
…els (ADR-0004) Updates the contributor- and consumer-facing top-level docs that the earlier ADR-0004 rollout PRs did not touch, so they no longer contradict the new calendar-versioning + dual-pace channel model. - CONTRIBUTING.md: edge (`main`) vs stable (`release/YYYY`) vs legacy (`release/v10`) branching; `target/YYYY` labels; breaking-changes-batched-to- yearly-cut + `[Experimental]` escape hatch; two-tier review; edge publishes to GitHub Packages, stable tags fire the release pipeline (nuget.org opt-in). Also drops the stale "don't fight .editorconfig/ReSharper" note. - README.md: reframe the v11/v12 callout around CalVer + channels; add a channels note to Install; fix the Build Status prose + release-row trigger (edge from `main` to GitHub Packages; stable from `release/YYYY` tags, nuget.org opt-in). - docs/roadmap.md: reframe "the next two majors" as theme-based milestones on the 2026 line / a later calendar major; drop hard-coded v11/v12/v13 version numbers while preserving the engineering content. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The edge channel publishes via the separate edge.yml workflow (push to main → GitHub Packages), not release.yml. Add an edge row and scope the release row to stable/legacy tag pushes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Aug 7, 2026
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
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.
Aligns the contributor- and consumer-facing top-level docs with the calendar-versioning + dual-pace channel model from ADR-0004. These are the living docs the earlier rollout PRs did not touch; they were still describing the old "any breaking change bumps the major / releases ship from
release/vN/ push tomainpublishes to nuget.org" world. PR 5 of the ADR-0004 rollout (afterAGENTS.md,docs/agents/release-and-versioning.md,docs/branching-and-release.md, and the ADR itself).Docs-only; no code changes. Wording/labels mirror
docs/agents/release-and-versioning.mdanddocs/branching-and-release.mdso nothing contradicts them.Files changed
CONTRIBUTING.md—main= edge channel,release/YYYY= stable train,release/v10= legacy (security/critical only);target/YYYYlabels (target/2026; legacy usestarget/v10); breaking changes batched to the yearly major cut (land onmainonly, held for next year,breaking-changelabel +⚠️callout + next-major CHANGELOG entry), with the[Experimental("FALLOUT0xx")]escape hatch; two-tier review (light on edge, rigorous on promotion); Releases section now reflects edge→GitHub Packages on merge + stable fromrelease/YYYYtags (nuget.org opt-in);release/vN→release/*in the CI-gate line. Also replaced the stale "don't fight.editorconfig/ReSharper settings" note (those files were removed during the takeover per AGENTS.md rule 6).README.md— reframed the v11/v12 IMPORTANT callout around CalVer + channels; added a "Channels" note under Install (stable CalVer fromrelease/YYYY, edge prerelease frommainto GitHub Packages, legacy10.xsemver); fixed the Build Status prose and thereleaseworkflow row trigger (was "push tomain— publishesFallout.*to nuget.org"). Global tool install (dotnet tool install -g Fallout.Cli, commandfallout) left unchanged as instructed.docs/roadmap.md— added a CalVer versioning note up top; reframed "the next two majors" as theme-based milestones (rebrand + plugin foundation on the 2026 line; public plugin SDK in a later calendar major); dropped hard-codedv11/v12/v13and11.1version numbers while preserving all the engineering/milestone content; tied breaking-changes-in-SDK-majors to the yearly cut and added the[Experimental]mention.Version shape
README/CONTRIBUTING use the neutral
2026.MINOR.PATCH-edge.…form to avoid baking in a specific prerelease tail. I did not rewrite the date-stamped2026.2.0-edge.<YYYYMMDD>.<h>shape used inrelease-and-versioning.md/branching-and-release.md— see the "left for human review" note below.Deliberately left untouched (flagging for human review)
2026.1.0-edge.<height>.g<commit>, but the already-merged source-of-truth docs (release-and-versioning.md,branching-and-release.md) and ADR-0004 itself consistently and deliberately use the date-stamped2026.2.0-edge.<YYYYMMDD>.<h>form (the ADR explicitly argues for date-in-prerelease-segment). I did not flip those docs to thegNNNshape — doing so would contradict the source-of-truth wording I was told to mirror, and the discrepancy looks like a deliberate decision rather than a typo. A human should confirm which prerelease tail is canonical and, if it's thegNNNform, fix all three docs (+ the ADR's runtime-shape references) in one consistent pass.docs/migration/from-globaltool-to-cli.md— references real shipped/unlisted package versions (Fallout.GlobalTool 10.3.40,Fallout.Cli 11.0.0, the unlisted10.3.41-47range, "v11 semver cleanup"). These are accurate history of a real migration event, not a versioning-model claim, so I left them. Renumbering them to CalVer would misstate what actually shipped.docs/agents/conventions.mdline ~12 ("per-file headers stripped in v11") — dated historical fact, not a forward-looking versioning statement; left as-is.docs/architecture.mdCI table — itsrelease.yml | push to main | Publish to GitHub Packagesrow is actually edge-accurate and doesn't assert a versioning model, so I left it. A maintainer may still want to add the tag-triggered stable path for completeness.Fallout.Common— live shields, not stale text; under the nuget.org-opt-in policy they may render "not found" until a stable release is pushed there. Left untouched per "don't overclaim/invent."vendor/directory was ignored as instructed (not added or removed).🤖 Generated with Claude Code