[qemu.qmp,08/12] docs: add versioning policy to README

Commit Message

John Snow April 22, 2022, 6:49 p.m. UTC

The package is in an alpha state, but there's a method to the madness.

Signed-off-by: John Snow <[e-mail]>
Reviewed-by: Damien Hedde <[e-mail]>
---
 README.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

Patch

diff --git a/README.rst b/README.rst
index 20f513e..cea1400 100644
--- a/README.rst
+++ b/README.rst
@@ -157,6 +157,28 @@  fail. These checks use their own `virtual environments
 working space.
 
 
+Stability and Versioning
+------------------------
+
+This package uses a major.minor.micro `SemVer versioning
+<https://semver.org/>`_, 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 <https://semver.org/>`_ / `PEP440
+<https://peps.python.org/pep-0440/>`_ rules will apply; micro updates
+will always be bugfixes, and minor updates will be reserved for
+backwards compatible feature changes.
+
+
 Changelog
 ---------