From 0809753123b32322bd195b4e1c601d56676fbfde Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Wed, 3 Apr 2024 21:25:24 -0500 Subject: [PATCH] docs(#19): clarify lts --- page/about/litestar-releases.rst | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/page/about/litestar-releases.rst b/page/about/litestar-releases.rst index dbc82b4..381ef0a 100644 --- a/page/about/litestar-releases.rst +++ b/page/about/litestar-releases.rst @@ -7,9 +7,14 @@ Version Numbering Litestar follows the `Semantic Versioning standard `_, using the ``..`` schema: -- **Major**: Backwards incompatible changes have been made -- **Minor**: Functionality was added in a backwards compatible manner -- **Patch**: Bugfixes were applied in a backwards compatible manner +**Major** + Backwards incompatible changes have been made + +**Minor** + Functionality was added in a backwards compatible manner + +**Patch** + Bugfixes were applied in a backwards compatible manner Pre-release Versions ++++++++++++++++++++ @@ -17,10 +22,15 @@ Pre-release Versions Before a new major release, we will make ``alpha``, ``beta``, and release candidate (``rc``) releases, numbered as ``..``. For example, ``2.0.0alpha1``, ``2.0.0beta1``, ``2.0.0rc1``. -- **alpha**: Early developer preview. Features may not be complete and breaking changes can occur. -- **beta**: More stable preview release. Feature complete, no major breaking changes expected. -- **rc**: Release candidate. Feature freeze, only bugfixes until final release. - Suitable for testing migration to the upcoming major release. +- ``alpha`` + Early developer preview. Features may not be complete and breaking changes can occur. + +- ``beta`` + More stable preview release. Feature complete, no major breaking changes expected. + +- ``rc`` + Release candidate. Feature freeze, only bugfixes until final release. + Suitable for testing migration to the upcoming major release. Long-term Support Releases (LTS) -------------------------------- @@ -52,7 +62,7 @@ At any time, the Litestar team will actively support: - The current major release series - The previous major release series -- Any other designated LTS releases +- Any other designated LTS releases (Special cases) For example, if the current release is ``2.0``, we will actively support ``2.x`` and ``1.x``. When ``3.0`` is released, we will drop support for ``1.x``.