Document the develop-leads versioning policy#333
Merged
Conversation
develop leads main by a minor: after a develop -> main release, bump develop's minor (isolated bump-version-X.Y PR) so develop prereleases sort above main's stable. Maintenance promotions hold main's version. Added to AGENTS.md Release Model and copilot-instructions. Propagated from ptr727/ProjectTemplate.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents the repository’s develop/main versioning policy (Nerdbank.GitVersioning semantics), clarifying how and when to bump develop’s minor so prereleases sort above main’s latest stable, and how to handle maintenance-only promotions.
Changes:
- Add an explicit “develop leads main by a minor” rule to AGENTS.md under the Release Model, including the rationale about SemVer prerelease ordering.
- Add a matching “Versioning” section to .github/copilot-instructions.md, with pointers back to AGENTS.md and the
version.jsonworkflow.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AGENTS.md | Adds the authoritative release/versioning rule to the Release Model section, including maintenance-promotion handling. |
| .github/copilot-instructions.md | Mirrors the versioning rule in agent-facing instructions and links back to AGENTS.md and version.json. |
Replace em-dashes with spaced hyphens per the Character Set convention (ASCII only in agent-authored docs).
State X.Y is the new minor (e.g. bump-version-3.5) and that this version-setting PR is the one place a version belongs in a PR title.
This was referenced Jun 15, 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.
Propagates the versioning rule from ptr727/ProjectTemplate:
developleadsmainby a minor (after adevelop -> mainrelease, bump develop's minor via an isolatedbump-version-X.YPR so develop's prereleases sort above main's stable), and maintenance promotions hold main's version. Added to AGENTS.md "Release Model" and `.github/copilot-instructions.md". (The README is the consumer-facing package readme with no dev-workflow section, so the rule lives in the agent-facing docs.)