Add a versioning policy to the README (#3151)

## Summary

Roughly mirrors https://docs.astral.sh/ruff/versioning/, but slimmed
down for now.
This commit is contained in:
Charlie Marsh 2024-04-21 12:02:41 -04:00 committed by GitHub
parent 7efd13ca33
commit 6c12e59d13
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions

View File

@ -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.