[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[qemu.qmp PATCH 10/13] docs: add versioning policy to README
From: |
John Snow |
Subject: |
[qemu.qmp PATCH 10/13] docs: add versioning policy to README |
Date: |
Wed, 30 Mar 2022 14:24:21 -0400 |
The package is in an alpha state, but there's a method to the madness.
Signed-off-by: John Snow <jsnow@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
- [qemu.qmp PATCH 00/13] python: fork qemu.qmp python lib into independent repo, John Snow, 2022/03/30
- [qemu.qmp PATCH 07/13] add a couple new trove classifiers, John Snow, 2022/03/30
- [qemu.qmp PATCH 01/13] pylint hotfix, John Snow, 2022/03/30
- [qemu.qmp PATCH 10/13] docs: add versioning policy to README,
John Snow <=
- [qemu.qmp PATCH 06/13] [FIXME] update project URLs, John Snow, 2022/03/30
- [qemu.qmp PATCH 04/13] update maintainer metadata, John Snow, 2022/03/30
- [qemu.qmp PATCH 03/13] update VERSION to 0.0.0a1, John Snow, 2022/03/30
- [qemu.qmp PATCH 02/13] fork qemu.qmp from qemu.git, John Snow, 2022/03/30
- [qemu.qmp PATCH 08/13] move README.rst to FILES.rst and update, John Snow, 2022/03/30
- [qemu.qmp PATCH 11/13] add LGPLv2+ and GPLv2 LICENSE files, John Snow, 2022/03/30
- [qemu.qmp PATCH 05/13] update project description, John Snow, 2022/03/30
- [qemu.qmp PATCH 12/13] update Pipfile, John Snow, 2022/03/30
- [qemu.qmp PATCH 09/13] [FIXME] move PACKAGE.rst to README.rst and update, John Snow, 2022/03/30
- [qemu.qmp PATCH 13/13] remove sub-dependency pins from Pipfile, John Snow, 2022/03/30