From d232e6f22848ecd7d31834f8cd3f631f8293b540 Mon Sep 17 00:00:00 2001 From: Alexey Kopytov Date: Sun, 15 Apr 2018 20:24:46 +0300 Subject: [PATCH] Add section about semantic versioning to README.md. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 6a6b78c..4173515 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ - [Usage](#usage) - [General Syntax](#general-syntax) - [General Command Line Options](#general-command-line-options) +- [Versioning](#versioning) @@ -259,6 +260,22 @@ The table below lists the supported common options, their descriptions and defau Note that numerical values for all *size* options (like `--thread-stack-size` in this table) may be specified by appending the corresponding multiplicative suffix (K for kilobytes, M for megabytes, G for gigabytes and T for terabytes). +# Versioning + +For transparency and insight into its release cycle, and for striving to maintain backward compatibility, sysbench will be maintained under the Semantic Versioning guidelines as much as possible. + +Releases will be numbered with the following format: + +`..` + +And constructed with the following guidelines: + +* Breaking backward compatibility bumps the major (and resets the minor and patch) +* New additions without breaking backward compatibility bumps the minor (and resets the patch) +* Bug fixes and misc changes bumps the patch + +For more information on SemVer, please visit [http://semver.org/](http://semver.org/). + [coveralls-badge]: https://coveralls.io/repos/github/akopytov/sysbench/badge.svg?branch=1.0 [coveralls-url]: https://coveralls.io/github/akopytov/sysbench?branch=1.0 [travis-badge]: https://travis-ci.org/akopytov/sysbench.svg?branch=1.0