summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorJames Falcon <james.falcon@canonical.com>2022-02-01 16:45:55 -0600
committerGitHub <noreply@github.com>2022-02-01 15:45:55 -0700
commit490cefd72d6e282804b877e9448438247e956f34 (patch)
tree4a36851867549a6f736586883ec8267610d18a7b /CONTRIBUTING.rst
parentaf7eb1deab12c7208853c5d18b55228e0ba29c4d (diff)
downloadcloud-init-git-490cefd72d6e282804b877e9448438247e956f34.tar.gz
docs: include upstream python version info (#1230)
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst27
1 files changed, 22 insertions, 5 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index cbd1ce3b..73122d79 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -197,6 +197,26 @@ Design
This section captures design decisions that are helpful to know when
hacking on cloud-init.
+Python Support
+--------------
+Cloud-init upstream currently supports Python 3.6 and above.
+
+Cloud-init upstream will stay compatible with a particular python version
+for 6 years after release. After 6 years, we will stop testing upstream
+changes against the unsupported version of python and may introduce
+breaking changes. This policy may change as needed.
+
+The following table lists the cloud-init versions in which the
+minimum python version changed:
+
+================== ==================
+Cloud-init version Python version
+================== ==================
+22.1 3.6+
+20.3 3.5+
+19.4 2.7+
+================== ==================
+
Cloud Config Modules
--------------------
@@ -213,11 +233,8 @@ Type Annotations
----------------
The cloud-init codebase uses Python's annotation support for storing
-type annotations in the style specified by `PEP-484`_. Their use in
-the codebase is encouraged but with one important caveat: only
-function annotations or comment annotations are supported, as the
-variable annotations specified in `PEP-526`_ were introduced in Python
-3.6.
+type annotations in the style specified by `PEP-484`_ and `PEP-526`_.
+Their use in the codebase is encouraged.
.. _PEP-484: https://www.python.org/dev/peps/pep-0484/
.. _PEP-526: https://www.python.org/dev/peps/pep-0526/