From: Étienne BERSAC <etienne.bersac@dalibo.com>
Date: Thu, 7 Sep 2017 14:32:49 +0000 (+0200)
Subject: Add HACKING to document tests
X-Git-Tag: v10.0~39^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b2eceb21fdf50f9b412b4215b73645bcb6c424cc;p=pgbadger

Add HACKING to document tests
---

diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..8c55c5c
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,18 @@
+# Contributing on pgBadger
+
+Thanks for your attention on pgBadger !
+
+pgBadger has a TAP compatible test suite executed by `prove(1)` on CI. You can
+write tests in many language including perl and bash.
+
+    $ apt install bats
+    ...
+    $ prove
+    t/basics.t .. ok 
+    t/syntax.t .. ok 
+    All tests successful.
+    Files=2, Tests=4,  2 wallclock secs ( 0.02 usr  0.00 sys +  2.38 cusr  0.04 csys =  2.44 CPU)
+    Result: PASS
+    $
+
+Please contribute a regression test when you fix a bug or add a feature. Thanks!