Skip to content

Commit

Permalink
Merge pull request #22 from ArtOfCode-/master
Browse files Browse the repository at this point in the history
Add docs section on testing
  • Loading branch information
AWegnerGitHub committed Mar 11, 2016
2 parents 9c37634 + d4fbd31 commit c1c6ee7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/dev/contributing.rst
Expand Up @@ -71,7 +71,22 @@ When contributing code, you'll want to follow this checklist:
GitHub Pull Requests are the expected method of code collaboration on this
project.

Running Tests
~~~~~~~~~~~~~

To be able to run the test suite, you'll need to have `mock`_ installed. Mock is
on the Python Package Index, so you can install it simply with one command:

$ pip install mock

Tests are built and run using `unittest`_, which comes as a standard package with
every Python installation. You can run the tests using the following command
(from the root directory of your clone):

$ python -m unittest discover tests/

.. _mock: https://pypi.python.org/pypi/mock
.. _unittest: https://docs.python.org/2/library/unittest.html

Code Review
~~~~~~~~~~~
Expand Down

0 comments on commit c1c6ee7

Please sign in to comment.