Difference between revisions of "Version Number"
(Clarifications) |
(Specification about alternative versions) |
||
| Line 13: | Line 13: | ||
* '''Release Candidate''' (RC) has no known bugs. | * '''Release Candidate''' (RC) has no known bugs. | ||
* '''Release''' should be bug free. | * '''Release''' should be bug free. | ||
| + | * '''Alternative''' versions should be unofficial and/or style modifications of any existing version. | ||
=== Preview === | === Preview === | ||
A Preview is a very early and incomplete copy of the software. It should give some impressions. | A Preview is a very early and incomplete copy of the software. It should give some impressions. | ||
| − | ;Examples for naming | + | ;Examples for naming |
* pre-3 | * pre-3 | ||
* preview4 | * preview4 | ||
| Line 25: | Line 26: | ||
An Alpha has (nearly) all things implemented and is much closer to a product than a Preview, but it has some known major bugs or some missing parts of the software. | An Alpha has (nearly) all things implemented and is much closer to a product than a Preview, but it has some known major bugs or some missing parts of the software. | ||
| − | ;Examples for naming | + | ;Examples for naming |
* alpha | * alpha | ||
* a4 | * a4 | ||
| Line 33: | Line 34: | ||
A Beta is nearly ready, has some known minor bugs, and works generally as expected. The author gives it away for tests to find more bugs. | A Beta is nearly ready, has some known minor bugs, and works generally as expected. The author gives it away for tests to find more bugs. | ||
| − | ;Examples for naming | + | ;Examples for naming |
* beta | * beta | ||
* b4 | * b4 | ||
| Line 41: | Line 42: | ||
A Release Candidate (RC) is a ''candidate for release''. The author means that it is bug-free (if not, the author must declare the known minor bugs) and gives it away for final tests. Release candidates may stay as release candidates for extended periods of development during which bugs are repeatedly found and fixed. | A Release Candidate (RC) is a ''candidate for release''. The author means that it is bug-free (if not, the author must declare the known minor bugs) and gives it away for final tests. Release candidates may stay as release candidates for extended periods of development during which bugs are repeatedly found and fixed. | ||
| − | ;Examples for naming | + | ;Examples for naming |
* RC1 | * RC1 | ||
* rc-2 | * rc-2 | ||
| Line 49: | Line 50: | ||
If the release candidate is stable and well-tested, the next version following it may become a Release and it is renamed to v* where * may be nearly anything. | If the release candidate is stable and well-tested, the next version following it may become a Release and it is renamed to v* where * may be nearly anything. | ||
| − | ;Examples for naming | + | ;Examples for naming |
| − | * v1 | + | * v1.0 |
* v1.2 | * v1.2 | ||
* v1a | * v1a | ||
| Line 56: | Line 57: | ||
* v00001.02.0003 | * v00001.02.0003 | ||
''The preceding '''v''' is often omitted for final releases, where the author has no initial intention of updating the software.'' | ''The preceding '''v''' is often omitted for final releases, where the author has no initial intention of updating the software.'' | ||
| + | |||
| + | === Alternative versions === | ||
| + | Unofficial and restylized versions should use *-alt instead of increasing the version number. This guarantees less confusion when official versions of the track (that may include fixes, complete remakes or more elements) are released. | ||
| + | |||
| + | ;Examples for naming | ||
| + | * v1.0-alt | ||
| + | * v1.1b-alt | ||
| + | * RC1-alt | ||
| + | * v2.alpha-5-alt | ||
== More Specific Version Numbers == | == More Specific Version Numbers == | ||
Version numbers can be combined with preview, alpha, beta or release candidate (for example, a beta for version 2). Separate the suffix from the main version number by a period. | Version numbers can be combined with preview, alpha, beta or release candidate (for example, a beta for version 2). Separate the suffix from the main version number by a period. | ||
| − | ;Examples for naming | + | ;Examples for naming |
* v3.pre-1 | * v3.pre-1 | ||
* v12.alpha | * v12.alpha | ||
| Line 69: | Line 79: | ||
A Proof of concept (PoC) is a software version to test a concept of anything, like the [http://www.youtube.com/watch?v=z4zaiKSKUqo »Train for Kalimari PoC«]. The goal of a PoC track is not to have a running track, but to find out if a technical detail will work. | A Proof of concept (PoC) is a software version to test a concept of anything, like the [http://www.youtube.com/watch?v=z4zaiKSKUqo »Train for Kalimari PoC«]. The goal of a PoC track is not to have a running track, but to find out if a technical detail will work. | ||
| − | ;Examples for naming | + | ;Examples for naming |
* PoC-1 | * PoC-1 | ||
* poc2 | * poc2 | ||
[[Category:General Information]] | [[Category:General Information]] | ||
Revision as of 20:24, 16 December 2019
Introduction
This article should help custom track, software and any kind of mod creators find a correct version number for their files. Files listed on the Wiiki are treated as software and should have proper software versioning. The purpose of software versioning is to help the creators stay organized.
Basic Versioning
Software development goes through several stages and many builds (compiled/generated versions). Sometimes the author wants to publish some of these builds, so the author should find a good version name. All version numbers regarding the same software must follow an order, thus the number or stage may not decrease in future versions.
The stages are not clearly defined and the following are only suggestions:
- Preview is a very early stage of the software and not usable.
- Alpha version is principally complete with known major bugs.
- Beta version is nearly ready with known minor bugs.
- Release Candidate (RC) has no known bugs.
- Release should be bug free.
- Alternative versions should be unofficial and/or style modifications of any existing version.
Preview
A Preview is a very early and incomplete copy of the software. It should give some impressions.
- Examples for naming
- pre-3
- preview4
- v3.pre5
Alpha
An Alpha has (nearly) all things implemented and is much closer to a product than a Preview, but it has some known major bugs or some missing parts of the software.
- Examples for naming
- alpha
- a4
- v3.alpha-5
Beta
A Beta is nearly ready, has some known minor bugs, and works generally as expected. The author gives it away for tests to find more bugs.
- Examples for naming
- beta
- b4
- v3.beta-5
Release Candidate
A Release Candidate (RC) is a candidate for release. The author means that it is bug-free (if not, the author must declare the known minor bugs) and gives it away for final tests. Release candidates may stay as release candidates for extended periods of development during which bugs are repeatedly found and fixed.
- Examples for naming
- RC1
- rc-2
- v3.rc2
Release
If the release candidate is stable and well-tested, the next version following it may become a Release and it is renamed to v* where * may be nearly anything.
- Examples for naming
- v1.0
- v1.2
- v1a
- v1.12b
- v00001.02.0003
The preceding v is often omitted for final releases, where the author has no initial intention of updating the software.
Alternative versions
Unofficial and restylized versions should use *-alt instead of increasing the version number. This guarantees less confusion when official versions of the track (that may include fixes, complete remakes or more elements) are released.
- Examples for naming
- v1.0-alt
- v1.1b-alt
- RC1-alt
- v2.alpha-5-alt
More Specific Version Numbers
Version numbers can be combined with preview, alpha, beta or release candidate (for example, a beta for version 2). Separate the suffix from the main version number by a period.
- Examples for naming
- v3.pre-1
- v12.alpha
- v2.b3 (b for beta)
- v5.RC3
Proof of concept
A Proof of concept (PoC) is a software version to test a concept of anything, like the »Train for Kalimari PoC«. The goal of a PoC track is not to have a running track, but to find out if a technical detail will work.
- Examples for naming
- PoC-1
- poc2