summaryrefslogtreecommitdiffstats
path: root/doc/development/unit-testing.txt
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2013-07-14 14:18:31 -0500
committerSol Jerome <sol.jerome@gmail.com>2013-07-14 14:18:31 -0500
commit15f003dfbb208a826818faaba76a1b5a3bc0a959 (patch)
treefaffbf9411c6e2f252efd9254de9a4714a49bda3 /doc/development/unit-testing.txt
parent5a2194e3778160474b8e1c6c9c0da882746f5b8c (diff)
downloadbcfg2-15f003dfbb208a826818faaba76a1b5a3bc0a959.tar.gz
bcfg2-15f003dfbb208a826818faaba76a1b5a3bc0a959.tar.bz2
bcfg2-15f003dfbb208a826818faaba76a1b5a3bc0a959.zip
doc: Add documentation for submitting patches
This should provide potential contributors with enough information to allow them to more easily create pull requests or send patches (especially for those who are not familiar with git). Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/development/unit-testing.txt')
-rw-r--r--doc/development/unit-testing.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/development/unit-testing.txt b/doc/development/unit-testing.txt
index 7311f49d7..8007e8c75 100644
--- a/doc/development/unit-testing.txt
+++ b/doc/development/unit-testing.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _development-unit-testing:
@@ -13,7 +14,7 @@ You will first need to install the `Python Mock Module`_ and `Python
Nose`_ modules. You can then run the existing tests with the
following:
-.. code-block: bash
+.. code-block: sh
cd testsuite
nosetests
@@ -123,7 +124,7 @@ writing tests for the base :class:`Bcfg2.Server.Plugin.base.Plugin`
class, which all Bcfg2 :ref:`server-plugins-index` inherit from via
the :mod:`Plugin interfaces <Bcfg2.Server.Plugin.interfaces>`,
yielding several levels of often-multiple inheritance. To make this
-easier, our unit tests adhere to several design considerations:
+easier, our unit tests adhere to several design considerations.
Inherit Tests
-------------