Versioning guide stub

facebook · Mar 18, 2022 · d24bdec · d24bdec
1 parent 63839ac
commit d24bdec
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,4 +1,7 @@
 Changelog
 =========
 
+See the :ref:`Versioning Guide <versioning>` for details on µsort's version scheme
+and recommendations on how to handle upgrades.
+
 .. mdinclude:: ../CHANGELOG.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,6 +18,7 @@
     :hidden:
     :maxdepth: 1
 
+    versioning
     changelog
     contributing
     code-of-conduct
diff --git a/docs/versioning.rst b/docs/versioning.rst
@@ -0,0 +1,8 @@
+
+.. _versioning:
+
+Versioning Guide
+================
+
+µsort tries to maintain the *spirit* of `SemVer <https://semver.org/>`_ while focusing
+more on the sorting and formatting results than strictly on the API contract.