diff options
| author | Steven Hiscocks <steven@hiscocks.me.uk> | 2014-03-29 22:07:33 +0000 |
|---|---|---|
| committer | Steven Hiscocks <steven@hiscocks.me.uk> | 2014-03-29 22:07:33 +0000 |
| commit | baeff6141ef8ab14f040999a503a3a7ce5cb6a1c (patch) | |
| tree | cfec1b11d5d6d23fb7660ce6e9617eb125b9d503 /DEVELOP | |
| parent | 70463882913393d1a0ac1ef3c58f8e0960528b2e (diff) | |
| download | fail2ban-baeff6141ef8ab14f040999a503a3a7ce5cb6a1c.tar.gz | |
DOC: sphinx documentation
Diffstat (limited to 'DEVELOP')
| -rw-r--r-- | DEVELOP | 43 |
1 files changed, 22 insertions, 21 deletions
@@ -1,4 +1,4 @@ - __ _ _ ___ _ +.. __ _ _ ___ _ / _|__ _(_) |_ ) |__ __ _ _ _ | _/ _` | | |/ /| '_ \/ _` | ' \ |_| \__,_|_|_/___|_.__/\__,_|_||_| @@ -25,6 +25,7 @@ Pull Requests ============= When submitting pull requests on GitHub we ask you to: + * Clearly describe the problem you're solving; * Don't introduce regressions that will make it hard for systems administrators to update; @@ -52,32 +53,32 @@ for more details. Install the package python-coverage to visualise your test coverage. Run the following (note: on Debian-based systems, the script is called -`python-coverage`): +`python-coverage`):: -coverage run bin/fail2ban-testcases -coverage html + coverage run bin/fail2ban-testcases + coverage html Then look at htmlcov/index.html and see how much coverage your test cases exert over the code base. Full coverage is a good thing however it may not be complete. Try to ensure tests cover as many independent paths through the code. -Manual Execution. To run in a development environment do: +Manual Execution. To run in a development environment do:: -./fail2ban-client -c config/ -s /tmp/f2b.sock -i start + ./fail2ban-client -c config/ -s /tmp/f2b.sock -i start -some quick commands: +some quick commands:: -status -add test pyinotify -status test -set test addaction iptables -set test actionban iptables echo <ip> <cidr> >> /tmp/ban -set test actionunban iptables echo <ip> <cidr> >> /tmp/unban -get test actionban iptables -get test actionunban iptables -set test banip 192.168.2.2 -status test + status + add test pyinotify + status test + set test addaction iptables + set test actionban iptables echo <ip> <cidr> >> /tmp/ban + set test actionunban iptables echo <ip> <cidr> >> /tmp/unban + get test actionban iptables + get test actionunban iptables + set test banip 192.168.2.2 + status test @@ -130,10 +131,10 @@ Git Use the following tags in your commit messages: -'BF:' for bug fixes -'DOC:' for documentation fixes -'ENH:' for enhancements -'TST:' for commits concerning tests only (thus not touching the main code-base) +* 'BF:' for bug fixes +* 'DOC:' for documentation fixes +* 'ENH:' for enhancements +* 'TST:' for commits concerning tests only (thus not touching the main code-base) Multiple tags could be joined with +, e.g. "BF+TST:". |