From ac57c7625a80c745ec640e7a1937375b2fe6828b Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Sun, 18 Feb 2018 11:00:06 -0600 Subject: [PATCH 1/3] minor copyediting --- docs/tutorial/electron-versioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/electron-versioning.md b/docs/tutorial/electron-versioning.md index 1100299cd326..cb09c6290ffc 100644 --- a/docs/tutorial/electron-versioning.md +++ b/docs/tutorial/electron-versioning.md @@ -16,7 +16,7 @@ npm install --save-dev electron@latest ## Version 1.x -Electron versions *< 2.0* did not conform to the [semver](http://semver.org) spec. Major versions corresponded to end-user API changes. Minor versions corresponded to Chromium major releases. Patch versions corresponded to new features and bug fixes. While convenient for developers merging features, it creates problems for developers of client-facing applications. The QA testing cycles of major apps like Slack, Stride, Teams, Skype, VS Code, Atom, and Desktop can be lengthy and stability is a highly desired outcome. There is a high risk in adopting new features while trying to absorb bug fixes. +Electron versions *< 2.0* did not conform to the [semver](http://semver.org) spec: major versions corresponded to end-user API changes, minor versions corresponded to Chromium major releases, and patch versions corresponded to new features and bug fixes. While convenient for developers merging features, it creates problems for developers of client-facing applications. The QA testing cycles of major apps like Slack, Stride, Teams, Skype, VS Code, Atom, and Desktop can be lengthy and stability is a highly desired outcome. There is a high risk in adopting new features while trying to absorb bug fixes. Here is an example of the 1.x strategy: From e3efe4b378268ffcd8547f401d52200e18c10536 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Sun, 18 Feb 2018 11:04:21 -0600 Subject: [PATCH 2/3] make the table a real table --- docs/tutorial/electron-versioning.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/docs/tutorial/electron-versioning.md b/docs/tutorial/electron-versioning.md index cb09c6290ffc..4e580c98a77b 100644 --- a/docs/tutorial/electron-versioning.md +++ b/docs/tutorial/electron-versioning.md @@ -42,17 +42,12 @@ From 2.0 onward, Electron will follow semver. Below is a table explicitly mapping types of changes to their corresponding category of semver (e.g. Major, Minor, Patch). -* **Major Version Increments** - * Chromium version updates - * node.js major version updates - * Electron breaking API changes -* **Minor Version Increments** - * node.js minor version updates - * Electron non-breaking API changes -* **Patch Version Increments** - * node.js patch version updates - * fix-related chromium patches - * Electron bug fixes +| Major Version Increments | Minor Version Increments | Patch Version Increments | +| ------------------------------- | ---------------------------------- | ----------------------------- | +| Electron breaking API changes | Electron non-breaking API changes | Electron bug fixes | +| node.js major version updates | node.js minor version updates | node.js patch version updates | +| Chromium version updates | | fix-related chromium patches | + Note that most chromium updates will be considered breaking. Fixes that can be backported will likely be cherry-picked as patches. From fbce7bafd7fe1a431dae67311fd03456c4b453c3 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Sun, 18 Feb 2018 23:14:08 -0600 Subject: [PATCH 3/3] capitalize 'Node.js' --- docs/tutorial/electron-versioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/electron-versioning.md b/docs/tutorial/electron-versioning.md index 4e580c98a77b..ecc62150131d 100644 --- a/docs/tutorial/electron-versioning.md +++ b/docs/tutorial/electron-versioning.md @@ -45,7 +45,7 @@ Below is a table explicitly mapping types of changes to their corresponding cate | Major Version Increments | Minor Version Increments | Patch Version Increments | | ------------------------------- | ---------------------------------- | ----------------------------- | | Electron breaking API changes | Electron non-breaking API changes | Electron bug fixes | -| node.js major version updates | node.js minor version updates | node.js patch version updates | +| Node.js major version updates | Node.js minor version updates | Node.js patch version updates | | Chromium version updates | | fix-related chromium patches |