summaryrefslogtreecommitdiff
path: root/doc/versioning.md
diff options
context:
space:
mode:
authorJF002 <jf@codingfield.com>2020-07-26 16:15:12 +0200
committerJF002 <jf@codingfield.com>2020-07-26 16:15:12 +0200
commit8c77c8631de753a4c32bc7c79a22a1452b37f3f6 (patch)
tree918b87567dc18514a12168ade58877dbcab20101 /doc/versioning.md
parent6222791aaeeef2e6e5020f7e08194a67c341d276 (diff)
Add doc about branches, versioning and contributions
Diffstat (limited to 'doc/versioning.md')
-rw-r--r--doc/versioning.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/versioning.md b/doc/versioning.md
new file mode 100644
index 00000000..b08af714
--- /dev/null
+++ b/doc/versioning.md
@@ -0,0 +1,6 @@
+# Versioning
+The versioning of this project is based on [Semantic versionning](https://semver.org/) :
+
+ - The **patch** is incremented when we fix a bug on a **released** version (most of the time using a **hotfix** branch).
+ - The **minor** is incremented when we release a new version with new features. It corresponds to a merge of **develop** into **master**.
+ - The **major** should be incremented when a breaking change is made to the application. We still have to define what is a breaking change in the context of this project. For now, I suggest that it stays **0** until we have a fully functionning firmware suited for the final user. \ No newline at end of file