Add versioning section to docs

learn2grid · Aug 8, 2021 · 660f566 · 660f566
1 parent 731e3a4
commit 660f566
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,18 +7,19 @@
    :maxdepth: 2
 
    installation.rst
+   versioning.md
    basic-usage.rst
    tutorials.rst
    performance.rst
    development.rst
    api/galois.rst
+   acknowledgements.md
+   citation.md
 
 .. toctree::
    :maxdepth: 1
 
    release-notes.md
-   acknowledgements.md
-   citation.md
 
 Indices and tables
 ------------------

diff --git a/docs/versioning.md b/docs/versioning.md
@@ -0,0 +1,8 @@
+# Versioning
+
+This project uses [semantic versioning](https://semver.org/). Releases are versioned `major.minor.patch`. Major releases introduce API-changing
+features. Minor releases add features and are backwards compatible with other releases in `major.x.x`. Patch releases fix bugs in a minor release
+and are backwards compatible with other releases in `major.minor.x`.
+
+Releases before `1.0.0` are alpha and beta releases. Alpha releases are `0.0.alpha`. There is no API compatibility guarantee for them. They can
+be thought of as `0.0.alpha-major`. Beta releases are `0.beta.x` and are API compatible. They can be thought of as `0.beta-major.beta-minor`.