aboutsummaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorGuido Günther <agx@sigxcpu.org>2015-02-21 16:31:53 +0100
committerGuido Günther <agx@sigxcpu.org>2015-03-27 12:10:55 +0100
commit19d92805f4828f010eba416723a607a56fa9dc07 (patch)
tree9cba1e7cf391bf20d9328c71222a1d536fc1761c /HACKING
parent82c3ae0b6e0280ef7946eb0cc7efd3c69d182e78 (diff)
Update docs on component tests and mailing list
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING29
1 files changed, 29 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..ff8b450
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,29 @@
+Running the Tests
+-----------------
+The tests are run via
+
+ python setup.py nosetests
+
+To also run the component tests you need to initialize the git submodules once
+via:
+
+ git submodule update --init --recursive
+
+This will fetch the necessary binary data for the DEB and RPM component tests
+and the tests are from now on included within each regular test run.
+
+
+Building the API Docs
+---------------------
+You can build the API docs using
+
+ epydoc -v --config=setup.cfg
+
+
+Contributing Patches
+--------------------
+Make sure the tests pass before sending in patch. You can either send it to the
+mailing list or add it to a bug report against git-buildpackage on
+
+ http://bugs.debian.org/src:git-buildpackage
+