STEP:Versioning: Difference between revisions

Revision as of 20:09, November 29, 2018

Implemented as of STEP 3.0.0[edit | edit source]

Major.Minor.Hotfix[edit | edit source]

Major - Introduce fundamental new functionality, tools used, or methods. (e.g., Official Pack implementation, changing from BOSS to LOOT or from Wrye Bash to MO).
Minor - changes to mod lineup (e.g., mods added or removed from a mod list).
Hotfix - Change/fix Guide instructions that require amendment to the changelog (however large or small) and any other 'hotfixes' (e.g., changes to mod install order, mod instruction updates, patch updates, etc).

Under this scheme[edit | edit source]

STEP Guide example: 2.9.2

v2 brought changes to mod sorting software, mod management software, and introduced alpha Pack support
v9 constitutes nine changes to the mods listed in the Guide since the change to v2.
v2 constitutes two bug/hotfixes have been released since the last mod lineup change (v9).

Examples[edit | edit source]

Template:Notice Small

Skyrim & potential new FO4 guides:[edit | edit source]

Skyrim (current Skyrim STEP Guide): 2.9.2

Switch to official Wrye Bash support: 3.0.0 (major change resets minor/hotfix)
Remove a mod or and new mods: 2.10.0 (minor change resets hotfix)
Correct/update guide/mod instructions: 2.9.3
Separate Extended from Core AND change mod management software: 3.0.0 (major change(s) resets minor & hotfix)

FO4 (brand new guide): 1.0.0

@@ Line 2: / Line 2: @@
 ==Implemented as of STEP 3.0.0==
 ==={{fc|addition|Major}}.{{fc|change|Minor}}.{{fc|important|Hotfix}}===
-* {{fc|addition|Major}} - Introduce fundamental new functionality, tools, or methods. (e.g., Official Pack implementation [i.e., STEP Extended, STEP ENB, STEP-sponsored Packs], BOSS to LOOT, Wrye Bash to MO).
+* {{fc|addition|Major}} - Introduce fundamental new functionality, tools used, or methods. (e.g., Official Pack implementation, changing from BOSS to LOOT or from Wrye Bash to MO).
-* {{fc|change|Minor}} - changes to mod lineup.
+* {{fc|change|Minor}} - changes to mod lineup (e.g., mods added or removed from a mod list).
-* {{fc|important|Hotfix}} - Change/fix Guide instructions that require amendment to the changelog (however large or small) and any other 'hotfixes' (e.g., changes to mod install order).
+* {{fc|important|Hotfix}} - Change/fix Guide instructions that require amendment to the changelog (however large or small) and any other 'hotfixes' (e.g., changes to mod install order, mod instruction updates, patch updates, etc).
 ====Under this scheme====
-Current STEP: {{fc|addition|2}}.{{fc|change|9}}.{{fc|important|2}}
+STEP Guide example: {{fc|addition|2}}.{{fc|change|9}}.{{fc|important|2}}
-* {{fc|addition|v2}} brought changes to mod sorting and mod management software and introduced Pack support (if we had been consistent, this version # should be up to maybe 3-4 by now, but water under the bridge)
+* {{fc|addition|v2}} brought changes to mod sorting software, mod management software, and introduced alpha Pack support
-* {{fc|change|v9}} constitutes lots of mod changes.
+* {{fc|change|v9}} constitutes nine changes to the mods listed in the Guide since the change to {{fc|addition|v2}}.
-* {{fc|important|v2}} constitutes hotfixes (if we had been historically consistent, some of these changes would have constituted {{fc|change|minor}} increments)
+* {{fc|important|v2}} constitutes two bug/hotfixes have been released since the last mod lineup change ({{fc|change|v9}}).
 =====Examples=====
-{{Notice Small|text=The following are only '''hypothetical examples''' to illustrate changes that would trigger a specific level of versioning!}}
+{{Notice Small|text=The following are only '''hypothetical examples''' to illustrate changes that would apply to a specific level of versioning!}}
 ======Skyrim & potential new FO4 guides:======
 '''Skyrim  (current Skyrim STEP Guide)''': {{fc|addition|2}}.{{fc|change|9}}.{{fc|important|2}}