[DOC] Add docs for versioning and changelog (#125)

Author: PabloRMira

README.md

@@ -262,6 +262,20 @@ FROM   (SELECT field1,
 
 5. Everything not being a query of the form `CREATE ... TABLE / VIEW` or `SELECT ...` is left unchanged
 
+## Versioning
+
+We version our package via [semantic versioning](https://semver.org), i.e., 
+
+* We use three digits separated by points x1.x2.x3, e.g. 0.5.1
+* We increase x1 (the major version) if we introduce breaking changes
+  * Exception: Versions with 0 at the beginning (e.g. 0.5.1) mean that the package is not stable yet and therefore every new feature could be a breaking change
+* We increase x2 (the minor version) if we introduce a new feature
+* We increase x3 (the patch version) if we fix a bug
+
+New documentation, refactoring / maintenance of code and admin tasks do not change the versions.
+
+You can follow the changes introduced by each version in our [CHANGELOG](https://github.com/PabloRMira/sql_formatter/blob/master/CHANGELOG.md)
+
 ## How to contribute
 
 You can contribute to this project:

docs/index.html

@@ -449,6 +449,30 @@ <h2 id="Formatting-Logic">Formatting Logic<a class="anchor-link" href="#Formatti
 </li>
 </ol>
 
+</div>
+</div>
+</div>
+<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+<h2 id="Versioning">Versioning<a class="anchor-link" href="#Versioning"> </a></h2>
+</div>
+</div>
+</div>
+<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+<p>We version our package via <a href="https://semver.org">semantic versioning</a>, i.e.,</p>
+<ul>
+<li>We use three digits separated by points x1.x2.x3, e.g. 0.5.1</li>
+<li>We increase x1 (the major version) if we introduce breaking changes<ul>
+<li>Exception: Versions with 0 at the beginning (e.g. 0.5.1) mean that the package is not stable yet and therefore every new feature could be a breaking change</li>
+</ul>
+</li>
+<li>We increase x2 (the minor version) if we introduce a new feature</li>
+<li>We increase x3 (the patch version) if we fix a bug</li>
+</ul>
+<p>New documentation, refactoring / maintenance of code and admin tasks do not change the versions.</p>
+<p>You can follow the changes introduced by each version in our <a href="https://github.com/PabloRMira/sql_formatter/blob/master/CHANGELOG.md">CHANGELOG</a></p>
+
 </div>
 </div>
 </div>

nbs/index.ipynb

@@ -398,6 +398,30 @@
     "5. Everything not being a query of the form `CREATE ... TABLE / VIEW` or `SELECT ...` is left unchanged"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Versioning"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We version our package via [semantic versioning](https://semver.org), i.e., \n",
+    "\n",
+    "* We use three digits separated by points x1.x2.x3, e.g. 0.5.1\n",
+    "* We increase x1 (the major version) if we introduce breaking changes\n",
+    "  * Exception: Versions with 0 at the beginning (e.g. 0.5.1) mean that the package is not stable yet and therefore every new feature could be a breaking change\n",
+    "* We increase x2 (the minor version) if we introduce a new feature\n",
+    "* We increase x3 (the patch version) if we fix a bug\n",
+    "\n",
+    "New documentation, refactoring / maintenance of code and admin tasks do not change the versions.\n",
+    "\n",
+    "You can follow the changes introduced by each version in our [CHANGELOG](https://github.com/PabloRMira/sql_formatter/blob/master/CHANGELOG.md)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},