From 2ea3d6e34edc4b40cc038d6fc29e5f5781196f83 Mon Sep 17 00:00:00 2001 From: jo Date: Tue, 15 Jul 2025 15:38:52 +0200 Subject: [PATCH 1/2] docs: add note about experimental features --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index a280f616..52e0ba8f 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,21 @@ for server in servers: We support python versions until [`end-of-life`](https://devguide.python.org/versions/#status-of-python-versions). +## Experimental features + +Experimental features are published as part of our regular releases (e.g. a product +public beta). During an experimental phase, breaking changes on those features may occur +within minor releases. + +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. + See https://docs.hetzner.cloud/changelog#$SLUG for more details. +``` + ## Development First, create a virtual environment and activate it: @@ -126,6 +141,21 @@ warnings.warn( ) ``` +### Releasing experimental features + +To publish experimental features as part of regular releases: + +- an announcement, including a link to a changelog entry, must written in the release notes. +- an `Experimental` notice, including a link to a changelog entry, must be added to the python classes and functions that are experimental: + + ```py + """ + Experimental: + $PRODUCT is experimental, breaking changes may occur within minor releases. + See https://docs.hetzner.cloud/changelog#$SLUG for more details. + """ + ``` + ## License The MIT License (MIT). Please see [`License File`](https://github.com/hetznercloud/hcloud-python/blob/main/LICENSE) for more information. From ecfda0eccfac65a2ed9e05d02496b435036e8217 Mon Sep 17 00:00:00 2001 From: jo Date: Mon, 21 Jul 2025 10:43:00 +0200 Subject: [PATCH 2/2] docs: fix wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 52e0ba8f..066e2906 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ warnings.warn( To publish experimental features as part of regular releases: -- an announcement, including a link to a changelog entry, must written in the release notes. +- an announcement, including a link to a changelog entry, must be added to the release notes. - an `Experimental` notice, including a link to a changelog entry, must be added to the python classes and functions that are experimental: ```py