diff --git a/README.rst b/README.rst index c6805c7..a483840 100644 --- a/README.rst +++ b/README.rst @@ -112,3 +112,14 @@ Manually This will launch the application at http://127.0.0.1:5000 + + +* To run unit-tests on pagure + + * Install the dependencies:: + + pip install -r tests_requirements.txt + + * Run it:: + + ./runtests.sh diff --git a/doc/development.rst b/doc/development.rst index 02820a4..096472d 100644 --- a/doc/development.rst +++ b/doc/development.rst @@ -250,6 +250,19 @@ expect it and the way we expect it. Tests checking that function are failing when/how we want are as important as tests checking they work the way they are intended to. + +So here are a few steps that one could perform to run unit-tests in a +local pagure instance. + +* Install the dependencies:: + + pip install -r tests_requirements.txt + +* Run it:: + + ./runtests.sh + + ``runtests.sh``, located at the top of the sources, helps to run the unit-tests of the project with coverage information using `python-nose `_.