Version policy

The Lottery Results API follows a version policy that specifies deprecations, API compatibility, and version numbering.

The release version is structured as MAJOR.MINOR.PATCH.

Alpha release

The alpha release is denoted by version v0.X.X. Upon the conclusion of the alpha phase, there will be a major version increment.

During the alpha phase of the application, breaking changes may be introduced without necessitating a major version update. However, a new minor version will be released, and the breaking changes will be documented.

Major release

Major releases may include breaking changes, which will be clearly documented. This documentation will provide detailed information on what is changing, the reasons for the changes, and instructions on how to migrate existing code to accommodate the new behavior.

Whenever possible, a deprecation path will be provided to avoid abrupt breaking changes.

Minor realease (0.1.0 -> 0.2.0): minor release includes larger bug fixes or new features that are backward compatible.

Patch release (0.1.0 -> 0.1.1): patch release will be used for bug fixes, which are backward compatible.

Sources

This document was written with the help of the following reference: https://py-pkgs.org/07-releasing-versioning.html