Skip to content

Commit 951560e

Browse files
committed
docs: add note about experimental features
1 parent a2f4eaf commit 951560e

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,21 @@ for server in servers:
6060

6161
We support python versions until [`end-of-life`](https://devguide.python.org/versions/#status-of-python-versions).
6262

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, module or function is experimental in its docstring:
71+
72+
```
73+
Experimental:
74+
Breaking changes may occur within minor releases.
75+
See https://docs.hetzner.cloud/changelog#slug
76+
```
77+
6378
## Development
6479

6580
First, create a virtual environment and activate it:
@@ -126,6 +141,22 @@ warnings.warn(
126141
)
127142
```
128143

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 modules, classes, and functions that are experimental:
150+
151+
```py
152+
"""Get image by name
153+
154+
Experimental:
155+
Breaking changes may occur within minor releases.
156+
See https://docs.hetzner.cloud/changelog#slug
157+
"""
158+
```
159+
129160
## License
130161

131162
The MIT License (MIT). Please see [`License File`](https://github.com/hetznercloud/hcloud-python/blob/main/LICENSE) for more information.

0 commit comments

Comments
 (0)