Skip to content

docs: add experimental features maturity #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jooola merged 2 commits into from
Sep 24, 2025
Merged

docs: add experimental features maturity #557

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c7bd2a
docs: add experimental features maturity
jooola Sep 23, 2025
0ee1d64
docs: add note about local and upstream stability
jooola Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,17 @@ Experimental features are published as part of our regular releases (e.g. a prod
public beta). During an experimental phase, breaking changes on those features may occur
within minor releases.

The stability of experimental features is not related to the stability of its upstream API.

Experimental features have different levels of maturity (e.g. experimental, alpha, beta)
based on the maturity of the upstream API.

While experimental features will be announced in the release notes, you can also find
whether a python class or function is experimental in its docstring:

```
Experimental:
$PRODUCT is experimental, breaking changes may occur within minor releases.
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
```

Expand Down Expand Up @@ -151,7 +156,7 @@ To publish experimental features as part of regular releases:
```py
"""
Experimental:
$PRODUCT is experimental, breaking changes may occur within minor releases.
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
"""
```
Expand Down