From 6c12e59d13de79ac05fd2dc289f4f6a64153b8a0 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Sun, 21 Apr 2024 12:02:41 -0400 Subject: [PATCH] Add a versioning policy to the README (#3151) ## Summary Roughly mirrors https://docs.astral.sh/ruff/versioning/, but slimmed down for now. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 7244f25ae..75fe106f0 100644 --- a/README.md +++ b/README.md @@ -527,6 +527,14 @@ In addition, uv respects the following environment variables: - `BASH_VERSION`: Used to detect the use of the Bash shell. - `ZSH_VERSION`: Used to detect the use of the Zsh shell. +## Versioning + +uv uses a custom versioning scheme in which the minor version number is bumped for breaking changes, +and the patch version number is bumped for bug fixes, enhancements, and other non-breaking changes. + +uv does not yet have a stable API; once uv's API is stable (v1.0.0), the versioning scheme will +adhere to [Semantic Versioning](https://semver.org/). + ## Acknowledgements uv's dependency resolver uses [PubGrub](https://github.com/pubgrub-rs/pubgrub) under the hood.