From 46bd5b0a170cb0ef81888b76e4e0089bcc614275 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Wed, 28 Nov 2018 00:33:42 -0400 Subject: [PATCH] Documentation: Improve versioning section Fix formatting of the versioning section and turn the list of version examples into a table. Add further examples for minor and micro releases. Signed-off-by: Roberto Rosario --- docs/chapters/development.rst | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/chapters/development.rst b/docs/chapters/development.rst index 526709a942..381e032260 100644 --- a/docs/chapters/development.rst +++ b/docs/chapters/development.rst @@ -447,13 +447,28 @@ Version numbering ================= Mayan EDMS uses the Semantic Versioning (http://semver.org/) method to choose -version numbers along with Python's PEP-0440 (https://www.python.org/dev/peps/pep-0440/) -to format them. +version numbers along with Python's PEP-0440 +(https://www.python.org/dev/peps/pep-0440/) to format them. -X.YaN # Alpha release -X.YbN # Beta release -X.YrcN # Release Candidate -X.Y # Final release ++----------------+-------------------+-----------------------------------------+ +| Version number | Name | Description | ++================+===================+=========================================+ +| X.YalphaN | Alpha release | Usable but unstable, API changes. | ++----------------+-------------------+-----------------------------------------+ +| X.YbetaN | Beta release | Code is frozen, testing. | ++----------------+-------------------+-----------------------------------------+ +| X.YrcN | Release Candidate | Almost ready for production, not major | +| | | changes between this version and the | +| | | final release. | ++----------------+-------------------+-----------------------------------------+ +| X.Y | Final release | API changes, many backward incompatible | +| | | changes. | ++----------------+-------------------+-----------------------------------------+ +| X.Y+1 | Minor release | Minor changes, minor backwards | +| | | incompatible changes | ++----------------+-------------------+-----------------------------------------+ +| X.Y.Z | Micro release | Minor changes, bugfixes. | ++----------------+-------------------+-----------------------------------------+ Release checklist