Skip to content

Commit 0c7bd2a

Browse files
committed
docs: add experimental features maturity
1 parent 2134cb8 commit 0c7bd2a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,15 @@ Experimental features are published as part of our regular releases (e.g. a prod
6666
public beta). During an experimental phase, breaking changes on those features may occur
6767
within minor releases.
6868

69+
Experimental features have different levels of maturity (e.g. experimental, alpha, beta)
70+
based on the maturity of the upstream API.
71+
6972
While experimental features will be announced in the release notes, you can also find
7073
whether a python class or function is experimental in its docstring:
7174

7275
```
7376
Experimental:
74-
$PRODUCT is experimental, breaking changes may occur within minor releases.
77+
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
7578
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
7679
```
7780

@@ -151,7 +154,7 @@ To publish experimental features as part of regular releases:
151154
```py
152155
"""
153156
Experimental:
154-
$PRODUCT is experimental, breaking changes may occur within minor releases.
157+
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
155158
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
156159
"""
157160
```

0 commit comments

Comments
 (0)