@@ -60,6 +60,21 @@ for server in servers:
60
60
61
61
We support python versions until [ ` end-of-life ` ] ( https://devguide.python.org/versions/#status-of-python-versions ) .
62
62
63
+ ## Experimental features
64
+
65
+ Experimental features are published as part of our regular releases (e.g. a product
66
+ public beta). During an experimental phase, breaking changes on those features may occur
67
+ within minor releases.
68
+
69
+ While experimental features will be announced in the release notes, you can also find
70
+ whether a python class or function is experimental in its docstring:
71
+
72
+ ```
73
+ Experimental:
74
+ $PRODUCT is experimental, breaking changes may occur within minor releases.
75
+ See https://docs.hetzner.cloud/changelog#$SLUG for more details.
76
+ ```
77
+
63
78
## Development
64
79
65
80
First, create a virtual environment and activate it:
@@ -126,6 +141,21 @@ warnings.warn(
126
141
)
127
142
```
128
143
144
+ ### Releasing experimental features
145
+
146
+ To publish experimental features as part of regular releases:
147
+
148
+ - an announcement, including a link to a changelog entry, must written in the release notes.
149
+ - an ` Experimental ` notice, including a link to a changelog entry, must be added to the python classes and functions that are experimental:
150
+
151
+ ``` py
152
+ """
153
+ Experimental:
154
+ $PRODUCT is experimental, breaking changes may occur within minor releases.
155
+ See https://docs.hetzner.cloud/changelog#$SLUG for more details.
156
+ """
157
+ ```
158
+
129
159
## License
130
160
131
161
The MIT License (MIT). Please see [ ` License File ` ] ( https://github.com/hetznercloud/hcloud-python/blob/main/LICENSE ) for more information.
0 commit comments