The package is in an alpha state, but there's a method to the madness. Signed-off-by: John Snow <js...@redhat.com> --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)
diff --git a/README.rst b/README.rst index 8593259..88efe84 100644 --- a/README.rst +++ b/README.rst @@ -154,6 +154,27 @@ fail. These checks use their own virtual environments and won't pollute your working space. +Stability and Versioning +------------------------ + +This package uses a major.minor.micro SemVer versioning, with the +following additional semantics during the alpha/beta period (Major +version 0): + +This package treats 0.0.z versions as "alpha" versions. Each micro +version update may change the API incompatibly. Early users are advised +to pin against explicit versions, but check for updates often. + +A planned 0.1.z version will introduce the first "beta", whereafter each +micro update will be backwards compatible, but each minor update will +not be. The first beta version will be released after legacy.py is +removed, and the API is tentatively "stable". + +Thereafter, normal SemVer/PEP440 rules will apply; micro updates will +always be bugfixes, and minor updates will be reserved for backwards +compatible feature changes. + + Changelog --------- -- 2.34.1
