Skip to content

Commit 2be9c1b

Browse files
committed
Formatted the semver token explanation
The formatting of the semver token explanation was a bit messy. Cleaned it up a bit by adding a list and code formatting.
1 parent 90b8744 commit 2be9c1b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/reference/intro-to-semver.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Version lock is when we rely on absolute versions, both **FacebookApi** and **Tw
88

99
Version Promiscuity is the opposite problem, **JsonLibrary** releases _v1.1.0_ with some breaking changes then we will just upgrade an **TwitterApi** will break unexpectedly.
1010

11-
SemVer introduces conventions about breaking changes into our version numbers so we can safely upgrade dependencies without fear of unexpected breaking changes while still allowing us to upgrade downstream libraries to get new features and bug fixes. The convention is quite simple.
12-
13-
{major}.{minor}.{patch}-{tag}+{buildmetadata}
14-
{major} = Only incremented if the release has breaking changes (includes bug fixes which have breaking behavioural changes
15-
{minor} = Incremented if the release has new non-breaking features
16-
{patch} = Incremented if the release only contains non-breaking bug fixes
17-
{tag} = Optional -{tag} denotes a pre-release of the version preceeding
18-
{buildmetadata} = Options +{buildmetadata} contains additional information about the version, but DOES NOT AFFECT the semantic version preceding it.
11+
SemVer introduces conventions about breaking changes into our version numbers so we can safely upgrade dependencies without fear of unexpected breaking changes while still allowing us to upgrade downstream libraries to get new features and bug fixes. The convention is quite simple:
12+
13+
* `{major}.{minor}.{patch}-{tag}+{buildmetadata}`
14+
* `{major}` is only incremented if the release has breaking changes (includes bug fixes which have breaking behavioural changes
15+
* `{minor}` is incremented if the release has new non-breaking features
16+
* `{patch}` is incremented if the release only contains non-breaking bug fixes
17+
* `{tag}` is optional and denotes a pre-release of the version preceeding
18+
* `{buildmetadata}` is optional and contains additional information about the version, but **does not affect** the semantic version preceding it.
1919

2020
Only one number should be incremented per release, and all lower parts should be reset to 0 (if major is incrememented then minor and patch should become 0).
2121

0 commit comments

Comments
 (0)