mirror of
https://github.com/semver/semver.git
synced 2026-03-22 05:59:55 -05:00
[PR #127] Added description for pre-stable public API versioning #752
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
📋 Pull Request Information
Original PR: https://github.com/semver/semver/pull/127
Author: @ChrisWren
Created: 7/1/2013
Status: 🔄 Open
Base:
master← Head:master📝 Commits (2)
3089fceAdded description for pre-stable public API versioningc26eb8dRemoved FAQ about 0.y.z revisioning📊 Changes
1 file changed (+9 additions, -7 deletions)
View changed files
📝
semver.md(+9 -7)📄 Description
When reading the description for major version zero I came across the line "Anything may change
at any time." I would like to create a more clear explanation of how versioning should take place before the first stable version of the public API so that developers can have meaning behind their pre-stable versioning.
This is especially an issue in node.js development as by default saved modules will pick up new patch versions but not new minor versions. If developers don't properly version their modules in a pre-stable state they can potentially break when users pick up new patch versions.
To define this pre-stable state I have proposed moving the definition for major and minor changes to the right, meaning that API-breaking changes result in a minor version being incremented and both backwards-compatible functional additions as well as bug fixes result in a patch version being incremented.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.