|
|
@@ -4,19 +4,29 @@ Releases
|
|
|
========
|
|
|
|
|
|
Releases for FlaskBB can be found on `pypi <https://pypi.org/project/FlaskBB>`_
|
|
|
-as well as on `github <https://github.com/flaskbb/flaskbb>`_. Each release of
|
|
|
-FlaskBB will have a git tag such as ``v2.0.0`` as well as a branch such as
|
|
|
-``2.0.0``. The ``master`` branch is always the latest version of FlaskBB and
|
|
|
-versions are cut from this branch.
|
|
|
+as well as on `github <https://github.com/flaskbb/flaskbb>`_.
|
|
|
|
|
|
-FlaskBB loosely follows semantic versions (semver) where all releases in each
|
|
|
-major version strive to be backwards compatibility, though sometimes this will
|
|
|
+FlaskBB loosely follows semantic versioning (semver) where all releases in each
|
|
|
+major version strive to be backwards compatible, though sometimes this will
|
|
|
be broken in order to apply a bugfix or security patch. When this occurs the
|
|
|
release notes will contain information about this.
|
|
|
|
|
|
Releases follow no particular cadence.
|
|
|
|
|
|
|
|
|
+Branching and Tagging
|
|
|
+~~~~~~~~~~~~~~~~~~~~~
|
|
|
+
|
|
|
+Each release of FlaskBB will have a git tag such as ``v2.0.0`` as well as a
|
|
|
+branch such as ``2.0.0``. Minor releases and patches reside in their major
|
|
|
+version branch (e.g. version 2.0.1 resides in the 2.0.0 branch).
|
|
|
+
|
|
|
+The ``master`` branch is always the latest version of FlaskBB and versions are
|
|
|
+cut from this branch.
|
|
|
+
|
|
|
+Feature and example branches may also be found in the official FlaskBB repo
|
|
|
+but these are not considered release ready and may be unstable.
|
|
|
+
|
|
|
Deprecation Policy
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
Alec Nikolas Reiter