From bd9463fe5856b111cf01225b6bbd84427ba4bd52 Mon Sep 17 00:00:00 2001
From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com>
Date: Thu, 15 Oct 2020 17:36:28 +0200
Subject: [PATCH] Added version scheme comment to main package init file

---
 nw/__init__.py | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/nw/__init__.py b/nw/__init__.py
index 72327b2b..6924f94d 100644
--- a/nw/__init__.py
+++ b/nw/__init__.py
@@ -35,6 +35,28 @@ from PyQt5.QtWidgets import QApplication, QErrorMessage
 from nw.error import exceptionHandler
 from nw.config import Config
 
+#
+#  Version Scheme
+# ================
+#  Generally follows PEP 440
+#  Hex Version:
+#  - Digit 1,2 : Major Version (01, 02, 03)
+#  = Digit 3,4 : Minor Version (01, 09, 10, 99)
+#  - Digit 5,6 : Patch Version (01, 09, 10, 99)
+#  = Digit 7   : Release Type (a: aplha, b: beta, c: candidate, f: final)
+#  - Digit 8   : Release Number (0-9)
+#
+#  Example    : Full        Short      Description
+# -------------------------------------------------------------------------
+#  0x010200a0 : 1.2-alpha0  1.2a0      Can be used for the dev branch
+#  0x010200a1 : 1.2-alpha1  1.2a1      First alpha release
+#  0x010200b1 : 1.2-beta1   1.2b1      First beta release
+#  0x010200c1 : 1.2-rc1     1.2rc1     First release candidate
+#  0x010200f0 : 1.2         1.2        Final release
+#  0x010200f1 : 1.2-post1   1.2.post1  Post release, but not a code patch!
+#
+#  0x010201f0 : 1.2.1       1.2.1      Patch release
+
 __package__    = "nw"
 __author__     = "Veronica Berglyd Olsen"
 __copyright__  = "Copyright 2018–2020, Veronica Berglyd Olsen"