Browse Source

remove section on semver, as electron does not fit its mold

Zeke Sikelianos 7 years ago
parent
commit
fe7c827e30
1 changed files with 3 additions and 28 deletions
  1. 3 28
      docs/tutorial/electron-versioning.md

+ 3 - 28
docs/tutorial/electron-versioning.md

@@ -2,34 +2,9 @@
 
 If you've been using Node and npm for a while, you are probably aware of [Semantic Versioning], or SemVer for short. It's a convention for specifying version numbers for software that helps communicate intentions to the users of your software.
 
-## Overview of Semantic Versioning
-
-Semantic versions are always made up of (at least) three numbers:
-
-```
-major.minor.patch
-```
-
-Semantic version numbers are bumped (incremented) using the following rules:
-
-* **Major** is for changes that break backwards compatibility.
-* **Minor** is for new features that don't break backwards compatibility.
-* **Patch** is for bug fixes and other minor changes.
-
-A simple mnemonic for remembering this scheme is as follows:
-
-```
-breaking.feature.fix
-```
-
-Unstable versions may also have a _pre-release identifier_. See 
-[Prereleases](#prereleases).
-
-## Electron Versioning
-
 Due to its dependency on Node and Chromium, it is not possible for the Electron
-project to adhere to a strict SemVer policy. **You should therefore always
-reference a specific version of Electron.**
+project to adhere to a strict [Semantic Versioning] policy. **You should 
+therefore always reference a specific version of Electron.**
 
 Electron version numbers are bumped using the following rules:
 
@@ -75,4 +50,4 @@ The `latest` and `next` [npm dist tags] are also used:
 [Semantic Versioning]: http://semver.org
 [pre-release identifier]: http://semver.org/#spec-item-9
 [npm dist tags]: https://docs.npmjs.com/cli/dist-tag
-[normal version]: http://semver.org/#spec-item-2
+[normal version]: http://semver.org/#spec-item-2