From f7e6683be7b84042513294b2f15e238f81a0b875 Mon Sep 17 00:00:00 2001 From: jvoisin Date: Wed, 21 Feb 2018 12:17:14 +0100 Subject: Add a CONTRIBUTING.md --- RELEASE.md | 46 ---------------------------------------------- 1 file changed, 46 deletions(-) delete mode 100644 RELEASE.md (limited to 'RELEASE.md') diff --git a/RELEASE.md b/RELEASE.md deleted file mode 100644 index 1c09c06..0000000 --- a/RELEASE.md +++ /dev/null @@ -1,46 +0,0 @@ -# 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: - -``` -$ make tests -[+] Congratz, the XX tests succeeded! -``` - -Otherwise, your modifications introduced a regression, fix them, -then **test again** until all tests are passing. - -## 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 may build a package, -hence the need to modify the changelog file to add an entry in the -`debian/changelog` file: - -You should use the `dch -i` command instead of editing the changelog by hand, -but if you don't have it installed, you can add something like this: - -``` -nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX - - * new feature - * bug fix - * moar documentation - - -- yournick `date -R` -``` - -Then you can commit on our git repository: - -``` -$ git commit -am "X.Y.Z" -$ git tag X.Y.Z -$ git push --tags -``` - -Do not forget to update the [milestones on github]( -https://github.com/nbs-system/php-malware-finder/milestones ). - -- cgit v1.3