[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[qemu.qmp PATCH 08/12] docs: add versioning policy to README
From: |
John Snow |
Subject: |
[qemu.qmp PATCH 08/12] docs: add versioning policy to README |
Date: |
Fri, 22 Apr 2022 14:49:36 -0400 |
The package is in an alpha state, but there's a method to the madness.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Damien Hedde <damien.hedde@greensocs.com>
---
README.rst | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
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
---------
--
2.34.1
- [qemu.qmp PATCH 02/12] update maintainer metadata, (continued)
- [qemu.qmp PATCH 02/12] update maintainer metadata, John Snow, 2022/04/22
- [qemu.qmp PATCH 07/12] move PACKAGE.rst to README.rst and update, John Snow, 2022/04/22
- [qemu.qmp PATCH 12/12] update VERSION to 0.0.0a1, John Snow, 2022/04/22
- [qemu.qmp PATCH 10/12] update Pipfile, John Snow, 2022/04/22
- [qemu.qmp PATCH 01/12] fork qemu.qmp from qemu.git, John Snow, 2022/04/22
- [qemu.qmp PATCH 08/12] docs: add versioning policy to README,
John Snow <=
- [qemu.qmp PATCH 06/12] move README.rst to FILES.rst and update, John Snow, 2022/04/22
- [qemu.qmp PATCH 09/12] add LGPLv2+ and GPLv2 LICENSE files, John Snow, 2022/04/22
- [qemu.qmp PATCH 05/12] add a couple new trove classifiers, John Snow, 2022/04/22
- Re: [qemu.qmp PATCH 00/12] python: fork qemu.qmp python lib into independent repo, John Snow, 2022/04/29