From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Damien Hedde <damien.hedde@greensocs.com>,
Daniel Berrange <berrange@redhat.com>,
Beraldo Leal <bleal@redhat.com>,
Kashyap Chamarthy <kchamart@redhat.com>,
Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [qemu.qmp PATCH 08/12] docs: add versioning policy to README
Date: Fri, 22 Apr 2022 14:49:36 -0400 [thread overview]
Message-ID: <20220422184940.1763958-9-jsnow@redhat.com> (raw)
In-Reply-To: <20220422184940.1763958-1-jsnow@redhat.com>
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
next prev parent reply other threads:[~2022-04-22 18:56 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-22 18:49 [qemu.qmp PATCH 00/12] python: fork qemu.qmp python lib into independent repo John Snow
2022-04-22 18:49 ` [qemu.qmp PATCH 01/12] fork qemu.qmp from qemu.git John Snow
2022-04-25 10:37 ` Daniel P. Berrangé
2022-04-25 18:54 ` John Snow
2022-04-22 18:49 ` [qemu.qmp PATCH 02/12] update maintainer metadata John Snow
2022-04-25 10:54 ` Daniel P. Berrangé
2022-04-25 18:15 ` John Snow
2022-04-22 18:49 ` [qemu.qmp PATCH 03/12] update project description John Snow
2022-04-29 13:44 ` Beraldo Leal
2022-04-22 18:49 ` [qemu.qmp PATCH 04/12] update project URLs John Snow
2022-04-25 10:56 ` Daniel P. Berrangé
2022-04-25 18:19 ` John Snow
2022-04-26 7:55 ` Daniel P. Berrangé
2022-04-26 8:16 ` Kashyap Chamarthy
2022-04-26 16:38 ` John Snow
2022-04-29 14:06 ` Beraldo Leal
2022-04-29 15:48 ` John Snow
2022-04-22 18:49 ` [qemu.qmp PATCH 05/12] add a couple new trove classifiers John Snow
2022-04-22 18:49 ` [qemu.qmp PATCH 06/12] move README.rst to FILES.rst and update John Snow
2022-04-25 13:23 ` Kashyap Chamarthy
2022-04-22 18:49 ` [qemu.qmp PATCH 07/12] move PACKAGE.rst to README.rst " John Snow
2022-04-22 18:49 ` John Snow [this message]
2022-04-22 18:49 ` [qemu.qmp PATCH 09/12] add LGPLv2+ and GPLv2 LICENSE files John Snow
2022-04-25 11:00 ` Daniel P. Berrangé
2022-04-22 18:49 ` [qemu.qmp PATCH 10/12] update Pipfile John Snow
2022-04-22 18:49 ` [qemu.qmp PATCH 11/12] remove sub-dependency pins from Pipfile John Snow
2022-04-25 13:19 ` Kashyap Chamarthy
2022-04-22 18:49 ` [qemu.qmp PATCH 12/12] update VERSION to 0.0.0a1 John Snow
2022-04-29 14:09 ` Beraldo Leal
2022-04-29 17:18 ` [qemu.qmp PATCH 00/12] python: fork qemu.qmp python lib into independent repo John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220422184940.1763958-9-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=berrange@redhat.com \
--cc=bleal@redhat.com \
--cc=crosa@redhat.com \
--cc=damien.hedde@greensocs.com \
--cc=kchamart@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).