summaryrefslogtreecommitdiff
path: root/RELEASE.md
diff options
context:
space:
mode:
authorjvoisin2018-02-21 12:17:14 +0100
committerjvoisin2018-02-21 12:17:14 +0100
commitf7e6683be7b84042513294b2f15e238f81a0b875 (patch)
tree9388cec3e45218729d68f524859046392e4e1b5e /RELEASE.md
parent419065b85aa877df67ee9e3e2db3b3fd9727cb90 (diff)
Add a CONTRIBUTING.md
Diffstat (limited to 'RELEASE.md')
-rw-r--r--RELEASE.md46
1 files changed, 0 insertions, 46 deletions
diff --git a/RELEASE.md b/RELEASE.md
deleted file mode 100644
index 1c09c06..0000000
--- a/RELEASE.md
+++ /dev/null
@@ -1,46 +0,0 @@
1# PHP Malware Finder release documentation
2
3## What should I do before releasing?
4
5Thou shalt test your modifications. If everything goes fine, you should see this
6message:
7
8```
9$ make tests
10[+] Congratz, the XX tests succeeded!
11```
12
13Otherwise, your modifications introduced a regression, fix them,
14then **test again** until all tests are passing.
15
16## OK, it's done, how do I release my new PMF version now?
17
18First, make sure enough modifications have been made to warrant a new release.
19Since PMF provides its own debian package files, you may build a package,
20hence the need to modify the changelog file to add an entry in the
21`debian/changelog` file:
22
23You should use the `dch -i` command instead of editing the changelog by hand,
24but if you don't have it installed, you can add something like this:
25
26```
27nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX
28
29 * new feature
30 * bug fix
31 * moar documentation
32
33 -- yournick <your@email.com> `date -R`
34```
35
36Then you can commit on our git repository:
37
38```
39$ git commit -am "X.Y.Z"
40$ git tag X.Y.Z
41$ git push --tags
42```
43
44Do not forget to update the [milestones on github](
45https://github.com/nbs-system/php-malware-finder/milestones ).
46