From dfee578aa6727f0dee8ab78fcea5bda3e5a3f305 Mon Sep 17 00:00:00 2001
From: vtexier <vit@free.fr>
Date: Thu, 2 Apr 2020 15:26:13 +0200
Subject: [PATCH] [enh] #104 add CONTRIBUTE.md file with release workflow

---
 CONTRIBUTE.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 CONTRIBUTE.md

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
new file mode 100644
index 00000000..044ff64a
--- /dev/null
+++ b/CONTRIBUTE.md
@@ -0,0 +1,18 @@
+# Contribute guide
+
+## Release workflow
+
+To handle a release, you have to respect this workflow:
+
+* Verify all features and bug fixes are merged in the `dev` branch.
+* Checkout on the `dev` branch
+* Update the `CHANGELOG.md` file and commit
+* Run the `release.sh` script with the version semantic number as argument:
+
+```bash
+./release.sh 0.50.0
+```
+
+* A new commit is added with the version number and a tag in git.
+* Merge all new commits from `dev` to `master` on GitLab with a merge request.
+* Release on PyPI from the GitLab pipeline manual job of the `master` branch.
-- 
GitLab