From ec399d92307b0df2d451b9e0494890b7c2d0ea48 Mon Sep 17 00:00:00 2001
From: Julien "shaddai" Reveret
Date: Fri, 29 Jul 2016 11:13:28 +0200
Subject: add a release file

---
 RELEASE.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 RELEASE.md

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..a1f67c0
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,38 @@
+# PHP Malware Finder release documentation
+
+## What should I do before releasing ?
+
+Thou shalt test your modifications. If everything goes fine, you should see this
+message:
+```
+$ ./tests.sh 
+[+] Congratz, the 54 tests succeeded!
+```
+
+Otherwise, your modifications introduced a regression, check how to fix this,
+then test again until all tests pass.
+
+## OK, it's done, how do I release my new PMF version now ?
+
+First, make sure enough modifications have been made to warrant a new release.
+Since PMF provides its own debian package files, you can build a package,
+hence need to modify the changelog file to add an entry in the debian/changelog
+file:
+
+```
+nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX
+
+  * new feature
+  * bug fix
+  * moar documentation
+
+ -- yournick <your@email.com>  `date -R`
+```
+
+Then you can commit on our git repository:
+```
+$ git commit -am "my changes"
+$ git tag X.Y.Z
+$ git push
+```
+
-- 
cgit v1.3