KEP-0005.txt
Jeroen van Meeuwen
vanmeeuwen at kolabsys.com
Tue Mar 1 14:13:41 CET 2011
KEP-0005.txt | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
New commits:
commit a8a3532c2033259957185a56b4ae6e7a896e1429
Author: Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen at kolabsys.com>
Date: Tue Mar 1 13:12:25 2011 +0000
As per feedback from Alex Potter, use less jargon and replace the use of 'to bump' with 'to increment'.
diff --git a/KEP-0005.txt b/KEP-0005.txt
index e162c44..066ceaf 100644
--- a/KEP-0005.txt
+++ b/KEP-0005.txt
@@ -26,9 +26,9 @@ In general, the following versioning guidelines establish the base-line for prod
=== The Major Version Component ===
-A Major version bump is often associated with a large change or set of large changes, and as such often causes the consumer to test the software, its features, and/or the upgrade path extensively despite whether ''Certified Binaries'' are available to that consumer. Additionally, the first minor or first few minors in a major series are often considered unstable and not suitable for large and/or mission-critical production environments.
+An increment of the Major component of the version is often associated with a large change or set of large changes, and as such often causes the consumer to test the software, its features, and/or the upgrade path extensively despite whether ''Certified Binaries'' are available to that consumer. Additionally, the first minor or first few minors in a major series are often considered unstable and not suitable for large and/or mission-critical production environments.
-The Major component in the product versioning shema '''MUST''' be bumped in any of the following situations;
+The Major component in the product versioning shema '''MUST''' be incremented in any of the following situations;
* No seemless (e.g. automatic without intervention, guaranteed) upgrade path exists,
* No downgrade path exists (for purposes of failed upgrade rollbacks),
@@ -36,33 +36,33 @@ The Major component in the product versioning shema '''MUST''' be bumped in any
* Changes to the product that entail '''functional changes''', e.g. a change in how the product works or how administrators or users can, should or must work with the product,
* backwards compatibility is broken (in terms of ABI, API and configuration changes).
-The Major component '''MAY''' be bumped in any of the following situations;
+The Major component '''MAY''' be incremented in any of the following situations;
* To emphasize the importance of the milestone achieved,
* To mark a point in time the versioning starts to conform to the guidelines documented here,
* Based on community and/or release engineering/management consensus.
-However, seeing as how bumping the major version raises expectations and workload on the receiving end of the product, careful consideration is warranted.
+However, seeing as how incrementing the major version raises expectations and workload on the receiving end of the product, careful consideration is warranted.
=== The Minor Version Component ===
-The general expectation formed with a bump of the Minor version component is to gain feature enhancements, such as performance increases, additional functions and/or components, and/or small rewrites of (parts of) code included in Kolab Groupware.
+The general expectation formed with an increment of the Minor version component is to gain feature enhancements, such as performance increases, additional functions and/or components, and/or small rewrites of (parts of) code included in Kolab Groupware.
-A Minor version bump usually warrants the following actions on the consumer end;
+An increment of the Minor component of the version usually warrants the following actions on the consumer end;
* Quick deployment of the former Minor version,
* Test upgrade path,
* Test base functionality,
* Test new functionality.
-The Minor component in the product versioning schema '''MUST''' be bumped in any of the following situations;
+The Minor component in the product versioning schema '''MUST''' be incremented in any of the following situations;
* Feature enhancements that require additional configuration or setup are included in the release,
* Despite whether the release contains only bug-fixes, the upgrade path is not seemless,
* Backwards compatibility is being marked deprecated in any ABI, API or configuration, and as such issues warnings in a reasonable fashion,
* Any of the components are upgraded, whether automatically or not.
-The Minor component in the product versioning schema '''MAY''' be bumped in any of the following situations;
+The Minor component in the product versioning schema '''MAY''' be incremented in any of the following situations;
* To emphasize the importance of the milestone achieved,
* To mark the end of a time-based development cycle,
@@ -70,7 +70,7 @@ The Minor component in the product versioning schema '''MAY''' be bumped in any
=== The Teeny Version Component ===
-The Teeny Version '''SHALL''' only be bumped for bug-fix releases. Included with bug-fix releases are, of course, security fixes. The ''update'' '''MUST''' be seemless.
+The Teeny Version '''SHALL''' only be incremented for bug-fix releases. Included with bug-fix releases are, of course, security fixes. The ''update'' '''MUST''' be seemless.
=== Release ===
More information about the commits
mailing list