Skip to content

Commit ffe178b

Browse files
authored
Merge pull request #719 from compas-dev/releases
Releases explanation
2 parents b9f1a2a + f257eb3 commit ffe178b

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Table of Contents
4040
plugins
4141
devguide
4242
changelog
43+
releases
4344
license
4445
citing
4546

docs/releases.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
********************************************************************************
2+
Releases
3+
********************************************************************************
4+
5+
.. rst-class:: lead
6+
7+
COMPAS releases are available on the Python Package Index (PyPI), on ``conda-forge``
8+
or directly from the Github repo.
9+
10+
Versions are tagged following the Semantic Versioning (semver) convention of ``MAJOR.MINOR.PATCH``.
11+
For more information see `Semantic Versioning 2.0.0 <https://semver.org/>`_.
12+
13+
The API of ``COMPAS`` was under heavy development up until ``COMPAS 0.19``,
14+
the last version series before ``1.0``.
15+
16+
Starting with ``1.0`` the API has been stabilized and the project adheres strictly to
17+
semver. In addition to the version number, major releases also have a name
18+
following the pattern ``<geometric adjective> <nautical term>``, with the words
19+
forming a tautogram in which the first letter increases alphabetically on every major
20+
release and rolls back to A after reaching Z. For example: ``COMPAS 16.0: Projective Pirate``.

0 commit comments

Comments
 (0)