Skip to content
Permalink
Browse files

create semvertag section

  • Loading branch information
mojombo committed Dec 17, 2009
1 parent 2702b46 commit 9f4613f9f0ee1330b75f9d97b261739eaa505c68
Showing with 13 additions and 5 deletions.
  1. +13 −5 index.md
@@ -15,15 +15,13 @@ As a solution to this problem, I propose a simple set of rules and requirements
I call this system "Semantic Versioning." Under this scheme, version numbers and the way they change convey meaning about the underlying code and what has been modified from one version to the next.


Semantic Versioning Specification
---------------------------------
Semantic Versioning Specification (SemVer)
------------------------------------------

1. Software using Semantic Versioning must declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it should be precise and comprehensive.
1. Software using Semantic Versioning MUST declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it should be precise and comprehensive.

1. A version number takes the form X.Y.Z where X, Y, and Z are integers. X is the major version, Y is the minor version, and Z is the patch version. Each element increases numerically such that version 1.0.10 follows 1.0.9.

1. When tagging releases in a version control system, the tag for a version MUST be "vX.Y.Z" e.g. "v3.1.0".

1. Once a versioned package has been released, the contents of that version MUST never be modified. Any modifications MUST be released as a new version.

1. Major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable.
@@ -37,6 +35,16 @@ Semantic Versioning Specification
1. Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API. It MAY include minor and patch level changes.


Tagging Specification (SemVerTag)
---------------------------------

This sub-specification is optional and SHOULD be used if you use a version control system (Git, Mercurial, SVN, etc) to store your code. Using this system allows automated tools to inspect your package and determine SemVer compliance and released versions.

1. When tagging releases in a version control system, the tag for a version MUST be "vX.Y.Z" e.g. "v3.1.0".

1. The first revision that introduces SemVer compliance SHOULD be tagged "semver". This allows pre-existing projects to assume compliance at any arbitrary point and for automated tools to discover this fact.


Why Use Semantic Versioning?
----------------------------

0 comments on commit 9f4613f

Please sign in to comment.
You can’t perform that action at this time.