Skip to content

docs: document development version convention - #202

Open
rsheyd wants to merge 1 commit into
romaintb:mainfrom
rsheyd:agent/document-dev-versions
Open

docs: document development version convention#202
rsheyd wants to merge 1 commit into
romaintb:mainfrom
rsheyd:agent/document-dev-versions

Conversation

@rsheyd

@rsheyd rsheyd commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

What changed

  • document the -dev.N SemVer prerelease convention for identifiable development builds;
  • explain when to increment the development-build number;
  • clarify that Cargo.toml and Cargo.lock should be updated together;
  • describe replacing the suffix with the final release version during release preparation.

Why

Contributors may need to install or share distinguishable development builds without adding build-time Git metadata or changing the version for every feature commit. A documented -dev.N convention provides a simple, standard way to identify those builds.

Validation

  • git diff --check
  • documentation-only change; Rust tests were not run

@rsheyd
rsheyd marked this pull request as ready for review July 31, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant