summaryrefslogtreecommitdiffstats
path: root/VERSIONING
diff options
context:
space:
mode:
Diffstat (limited to 'VERSIONING')
-rw-r--r--VERSIONING16
1 files changed, 16 insertions, 0 deletions
diff --git a/VERSIONING b/VERSIONING
new file mode 100644
index 0000000..da8926a
--- /dev/null
+++ b/VERSIONING
@@ -0,0 +1,16 @@
+This software uses Semantic Versioning.
+
+Given a version number MAJOR.MINOR.PATCH, increment the:
+
+1. MAJOR version when you make incompatible API changes,
+2. MINOR version when you add functionality in a backwards compatible manner, and
+3. PATCH version when you make backwards compatible bug fixes.
+
+In addition this software uses labels such as RELEASE CANDIDATE for when I think things
+good enough for a STABLE RELEASE but needs further real world testing. RELEASE
+versions are tagged with Git so that you may checkout and build specific releases.
+
+Non-tagged versions are essentially developer nightly versions and NOT intended for
+general usage.
+
+see https://semver.org/ for the specifics