STEP:Versioning: Difference between revisions
From Step Mods | Change The Game
TechAngel85 (talk | contribs) (changed "Major" from blue to green color as the blue looks like links. We should avoid blue for font as much as possible.) |
TechAngel85 (talk | contribs) (→{{fc|green|Major}}.{{fc|change|Minor}}.{{fc|important|Hotfix}}: Did some general cleaning up, updating, and moving things around.) |
||
Line 2: | Line 2: | ||
==Implemented as of STEP 2.10.0== | ==Implemented as of STEP 2.10.0== | ||
==={{fc|green|Major}}.{{fc|change|Minor}}.{{fc|important|Hotfix}}=== | ==={{fc|green|Major}}.{{fc|change|Minor}}.{{fc|important|Hotfix}}=== | ||
* {{fc|green|Major}} - | * {{fc|green|Major}} - introduce new functionality, mod groups, guide section, tools, or methods. (e.g., changing from Wrye Bash to MO, adding a new tool, adding a new mod group, etc.) | ||
* {{fc|change|Minor}} - changes to guide mod list. | * {{fc|change|Minor}} - changes to guide mod list or tool instructions. (e.g., adding/removing mods, changing selections in BethINI, etc.) | ||
* {{fc|important|Hotfix}} - | * {{fc|important|Hotfix}} - changes/fixes that require immediate remedial actions. (e.g., corrections to guide instructions, changes to mod install order, updates to mod instructions, Patch updates, etc.) | ||
** Hotfixes are typically released when a small collection of these "fixes" have accumulated. Until that time, changes will be reflected on the current Changelog. | |||
* 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==== | ||
<p>'''New Guide Versioning''': {{fc|green|1}}.{{fc|change|0}}.{{fc|important|0}} | |||
* New guides start at the beginning of the versioning scheme. | |||
</p> | |||
<p>'''Beta Versioning''': {{fc|green|0}}.{{fc|change|1}}.{{fc|important|0}} | |||
* {{fc|green|Major}} is always {{fc|green|0}} when releases are in a beta state. Only a full release can trigger a change to {{fc|green|Major}}, at which point version defaults New Guide versioning. | |||
* The remainder of the scheme will remain the same. | |||
</p> | |||
====Examples==== | |||
STEP Guide version example: {{fc|green|2}}.{{fc|change|9}}.{{fc|important|2}} | STEP Guide version example: {{fc|green|2}}.{{fc|change|9}}.{{fc|important|2}} | ||
* {{fc|green|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|green|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}}). | ||
{{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 Guides:===== | |||
'''Skyrim (current Skyrim STEP Guide version)''': {{fc|green|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|green|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) | ||
Line 19: | Line 30: | ||
* Update mod installation instructions: {{fc|green|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|green|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}} | ||
Revision as of 23:54, June 25, 2021
Implemented as of STEP 2.10.0
Major.Minor.Hotfix
- Major - introduce new functionality, mod groups, guide section, tools, or methods. (e.g., changing from Wrye Bash to MO, adding a new tool, adding a new mod group, etc.)
- Minor - changes to guide mod list or tool instructions. (e.g., adding/removing mods, changing selections in BethINI, etc.)
- Hotfix - changes/fixes that require immediate remedial actions. (e.g., corrections to guide instructions, changes to mod install order, updates to mod instructions, Patch updates, etc.)
- Hotfixes are typically released when a small collection of these "fixes" have accumulated. Until that time, changes will be reflected on the current Changelog.
- 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
New Guide Versioning: 1.0.0
- New guides start at the beginning of the versioning scheme.
Beta Versioning: 0.1.0
- Major is always 0 when releases are in a beta state. Only a full release can trigger a change to Major, at which point version defaults New Guide versioning.
- The remainder of the scheme will remain the same.
Examples
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).
Skyrim Guides:
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