Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify minor and patch versions #588

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clarify minor and patch versions #588

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2afc6cc
Clarify that changes refers to the API in MINOR versions
magjac Jul 4, 2020
bc17890
Clarify that PATCH versions are not limited to bug fixes
magjac Jul 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions semver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Summary
Given a version number MAJOR.MINOR.PATCH, increment the:

1. MAJOR version when you make incompatible API changes
1. MINOR version when you add functionality in a backward compatible
1. MINOR version when you add functionality to the API in a backward compatible
manner
1. PATCH version when you make backward compatible bug fixes
1. PATCH version when you make backward compatible bug fixes or other changes
not affecting the API

Additional labels for pre-release and build metadata are available as extensions
to the MAJOR.MINOR.PATCH format.
Expand Down Expand Up @@ -39,10 +40,10 @@ For this system to work, you first need to declare a public API. This may
consist of documentation or be enforced by the code itself. Regardless, it is
important that this API be clear and precise. Once you identify your public
API, you communicate changes to it with specific increments to your version
number. Consider a version format of X.Y.Z (Major.Minor.Patch). Bug fixes not
affecting the API increment the patch version, backward compatible API
additions/changes increment the minor version, and backward incompatible API
changes increment the major version.
number. Consider a version format of X.Y.Z (Major.Minor.Patch). Bug fixes or
other changes not affecting the API increment the patch version, backward
compatible API additions/changes increment the minor version, and backward
incompatible API changes increment the major version.

We call this system "Semantic Versioning." Under this scheme, version numbers
and the way they change convey meaning about the underlying code and what has
Expand Down Expand Up @@ -75,8 +76,8 @@ is incremented after this release is dependent on this public API and how it
changes.

1. Patch version Z (x.y.Z | x > 0) MUST be incremented if only backward
compatible bug fixes are introduced. A bug fix is defined as an internal
change that fixes incorrect behavior.
compatible bug fixes or other changes not affecting the API are introduced. A
bug fix is defined as an internal change that fixes incorrect behavior.

1. Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backward
compatible functionality is introduced to the public API. It MUST be
Expand Down