STEP:Versioning: Difference between revisions

From Step Mods | Change The Game
(changed "Major" from blue to green color as the blue looks like links. We should avoid blue for font as much as possible.)
Line 1: Line 1:
__NOTOC__[[Category:Administration]]
__NOTOC__[[Category:Administration]]
==Implemented as of STEP 2.10.0==
==Implemented as of STEP 2.10.0==
==={{fc|addition|Major}}.{{fc|change|Minor}}.{{fc|important|Hotfix}}===  
==={{fc|green|Major}}.{{fc|change|Minor}}.{{fc|important|Hotfix}}===  
* {{fc|addition|Major}} - Introduce fundamental new functionality, tools, or methods. (e.g., Official Pack implementation, changing from BOSS to LOOT or from Wrye Bash to MO).
* {{fc|green|Major}} - Introduce fundamental new functionality, tools, or methods. (e.g., Official Pack implementation, changing from BOSS to LOOT or from Wrye Bash to MO).
* {{fc|change|Minor}} - changes to guide mod list.
* {{fc|change|Minor}} - changes to guide 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, mod instruction updates, patch updates, etc).
* {{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).
* If a guide version is in a pre-release state, the version number may have a 'b' suffix to indicate a 'beta' version state.
* If a guide version is in a pre-release state, the version number may have a 'b' suffix to indicate a 'beta' version state.
====Under this scheme====
====Under this scheme====
STEP Guide version example: {{fc|addition|2}}.{{fc|change|9}}.{{fc|important|2}}
STEP Guide version example: {{fc|green|2}}.{{fc|change|9}}.{{fc|important|2}}
* {{fc|addition|v2}} brought changes to mod sorting software, mod management software, and introduced alpha Pack support
* {{fc|green|v2}} brought changes to mod sorting software, mod management software, and introduced alpha Pack support
* {{fc|change|v9}} constitutes nine changes to the mod lineup since the change to {{fc|addition|v2}}.
* {{fc|change|v9}} constitutes nine changes to the mod lineup since the change to {{fc|green|v2}}.
* {{fc|important|v2}} constitutes two bug/hotfixes have been released since the last mod lineup change ({{fc|change|v9}}).
* {{fc|important|v2}} constitutes two bug/hotfixes have been released since the last mod lineup change ({{fc|change|v9}}).
=====Examples=====
=====Examples=====
{{AlertSmall‏‎|type=notice|text=The following are only '''hypothetical examples''' to illustrate changes that would apply to a specific level of versioning.}}
{{AlertSmall‏‎|type=notice|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 & potential new FO4 guides:======
'''Skyrim  (current Skyrim STEP Guide version)''': {{fc|addition|2}}.{{fc|change|9}}.{{fc|important|2}}
'''Skyrim  (current Skyrim STEP Guide version)''': {{fc|green|2}}.{{fc|change|9}}.{{fc|important|2}}
* Switch to official Wrye Bash support: {{fc|addition|3}}.{{fc|change|0}}.{{fc|important|0}} (major changes resets minor/hotfix versions)
* Switch to official Wrye Bash support: {{fc|green|3}}.{{fc|change|0}}.{{fc|important|0}} (major changes resets minor/hotfix versions)
* Remove a mod or add new mods: {{fc|addition|2}}.{{fc|change|10}}.{{fc|important|0}} (minor changes resets hotfix version)
* Remove a mod or add new mods: {{fc|green|2}}.{{fc|change|10}}.{{fc|important|0}} (minor changes resets hotfix version)
* Update mod installation instructions: {{fc|addition|2}}.{{fc|change|9}}.{{fc|important|3}}
* Update mod installation instructions: {{fc|green|2}}.{{fc|change|9}}.{{fc|important|3}}
* Separate Extended Pack from Core Guide AND change mod management software: {{fc|addition|3}}.{{fc|change|0}}.{{fc|important|0}}
* Separate Extended Pack from Core Guide AND change mod management software: {{fc|green|3}}.{{fc|change|0}}.{{fc|important|0}}
'''FO4 (brand new guide)''': {{fc|addition|1}}.{{fc|change|0}}.{{fc|important|0}} (new guides start at the beginning)
'''FO4 (brand new guide)''': {{fc|green|1}}.{{fc|change|0}}.{{fc|important|0}} (new guides start at the beginning)

Revision as of 23:22, June 25, 2021

Implemented as of STEP 2.10.0[edit | edit source]

Major.Minor.Hotfix[edit | edit source]

  • Major - Introduce fundamental new functionality, tools, or methods. (e.g., Official Pack implementation, changing from BOSS to LOOT or from Wrye Bash to MO).
  • Minor - changes to guide 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).
  • If a guide version is in a pre-release state, the version number may have a 'b' suffix to indicate a 'beta' version state.

Under this scheme[edit | edit source]

STEP Guide version 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 mod lineup since the change to v2.
  • v2 constitutes two bug/hotfixes have been released since the last mod lineup change (v9).
Examples[edit | edit source]
Info-Logo.png
NOTE:
The following are only hypothetical examples to illustrate changes that would apply to a specific level of versioning.
Skyrim & potential new FO4 guides:[edit | edit source]

Skyrim (current Skyrim STEP Guide version): 2.9.2

  • Switch to official Wrye Bash support: 3.0.0 (major changes resets minor/hotfix versions)
  • Remove a mod or add new mods: 2.10.0 (minor changes resets hotfix version)
  • Update mod installation instructions: 2.9.3
  • Separate Extended Pack from Core Guide AND change mod management software: 3.0.0

FO4 (brand new guide): 1.0.0 (new guides start at the beginning)