1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
Contribute to the code
**********************
.. toctree::
:maxdepth: 1
:hidden:
testing.rst
integration_tests.rst
module_creation.rst
datasource_creation.rst
dir_layout.rst
feature_flags.rst
For a run-through of the entire process, the following pages will be your best
starting point:
* :doc:`Find issues to work on<find_issues>`
* :doc:`Build your first pull request<first_PR>`
* :doc:`Our code review process<code_review>`
On the rest of this page you'll find the key resources you'll need to start
contributing to the cloud-init codebase.
Testing
=======
Submissions to cloud-init must include testing. Unit testing and integration
testing are integral parts of contributing code.
Code style and design
=====================
We generally adhere to `PEP 8`_, and this is enforced by our use of ``black``,
``isort`` and ``ruff``.
Python support
--------------
Cloud-init upstream currently supports Python 3.8 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:
.. list-table::
:header-rows: 1
:align: center
* - Cloud-init version
- Python version
* - 24.3
- 3.8+
* - 22.1
- 3.6+
* - 20.3
- 3.5+
* - 19.4
- 2.7+
Type annotations
----------------
The cloud-init codebase uses Python's annotation support for storing type
annotations in the style specified by `PEP-484`_ and `PEP-526`_. Their use in
the codebase is encouraged.
.. LINKS:
.. include:: ../links.txt
.. _quickstart documentation: https://docs.github.com/en/get-started/quickstart
.. _repository: https://github.com/canonical/cloud-init
.. _contributor-agreement-canonical: https://launchpad.net/%7Econtributor-agreement-canonical/+members
.. _PR #344: https://github.com/canonical/cloud-init/pull/344
.. _PR #345: https://github.com/canonical/cloud-init/pull/345
.. _PEP-484: https://www.python.org/dev/peps/pep-0484/
.. _PEP-526: https://www.python.org/dev/peps/pep-0526/
.. _PEP 8: https://peps.python.org/pep-0008/
|
