Skip to content

Commit 9aa65a7

Browse files
committed
starting point
1 parent b9f1a2a commit 9aa65a7

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 current version of COMPAS is ``0.19.1``, which means we have not yet established a compleltely stable API.
14+
However, the ``0.19`` version series is the last before the release of ``COMPAS 1.0.0``!
15+
16+
In the future, in addition to a version number, major releases will also have a name following the pattern
17+
``<geometric adjective> <nautical term>``, with the words forming an alliteration and the alliteration letter correspoding to the number of the release.
18+
For example, the first release could be ``COMPAS 1.0.0: the Affine Admiral``.
19+
The second could be ``COMPAS 2.0.0: the Barycentric Bulkhead``, and so on.
20+

0 commit comments

Comments
 (0)