From b1d20ac195db9602b34e90be182486d9f77601a2 Mon Sep 17 00:00:00 2001 From: Marcin Rudolf Date: Mon, 16 Sep 2024 14:44:58 +0200 Subject: [PATCH] adds new versioning scheme to README --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bc0f40b62f..ee2b2e1fdc 100644 --- a/README.md +++ b/README.md @@ -94,15 +94,16 @@ You can find examples for various use cases in the [examples](docs/examples) fol ## Adding as dependency -`dlt` follows the semantic versioning with the [`MAJOR.MINOR.PATCH`](https://peps.python.org/pep-0440/#semantic-versioning) pattern. Currently, we are using **pre-release versioning** with the major version being 0. +`dlt` follows the semantic versioning with the [`MAJOR.MINOR.PATCH`](https://peps.python.org/pep-0440/#semantic-versioning) pattern. -- `minor` version change means breaking changes -- `patch` version change means new features that should be backward compatible -- any suffix change, e.g., `post10` -> `post11`, is considered a patch +* `major` means breaking changes and removed deprecations +* `minor` new features, sometimes automatic migrations +* `patch` bug fixes We suggest that you allow only `patch` level updates automatically: -* Using the [Compatible Release Specifier](https://packaging.python.org/en/latest/specifications/version-specifiers/#compatible-release). For example **dlt~=0.3.10** allows only versions **>=0.3.10** and less than **<0.4** -* Poetry [caret requirements](https://python-poetry.org/docs/dependency-specification/). For example **^0.3.10** allows only versions **>=0.3.10** to **<0.4** +* Using the [Compatible Release Specifier](https://packaging.python.org/en/latest/specifications/version-specifiers/#compatible-release). For example **dlt~=1.0** allows only versions **>=1.0** and less than **<1.1** +* Poetry [caret requirements](https://python-poetry.org/docs/dependency-specification/). For example **^1.0** allows only versions **>=1.0** to **<1.0** + ## Get Involved The dlt project is quickly growing, and we're excited to have you join our community! Here's how you can get involved: