Add section about semantic versioning to README.md.
This commit is contained in:
17
README.md
17
README.md
@ -25,6 +25,7 @@
|
||||
- [Usage](#usage)
|
||||
- [General Syntax](#general-syntax)
|
||||
- [General Command Line Options](#general-command-line-options)
|
||||
- [Versioning](#versioning)
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
@ -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:
|
||||
|
||||
`<major>.<minor>.<patch>`
|
||||
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user