Changeset - 1daec1628e0b
[Not reviewed]
default
0 1 0
Thomas De Schampheleire - 8 years ago 2017-06-28 21:24:54
thomas.de.schampheleire@gmail.com
docs/contributing: move installation of dev_requirements to default instructions

When intending to contribute to Kallithea, you are expected to run all
tests, so installation of the dev_requirements are actually mandatory.
Hence, update the instructions.
1 file changed with 3 insertions and 4 deletions:
0 comments (0 inline, 0 general)
docs/contributing.rst
Show inline comments
 
@@ -33,12 +33,13 @@ To get started with Kallithea developmen
 
        hg clone https://kallithea-scm.org/repos/kallithea
 
        cd kallithea
 
        virtualenv ../kallithea-venv
 
        source ../kallithea-venv/bin/activate
 
        pip install --upgrade pip setuptools
 
        pip install -e .
 
        pip install -r dev_requirements.txt
 
        gearbox make-config my.ini
 
        gearbox setup-db -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp
 
        gearbox serve -c my.ini --reload &
 
        firefox http://127.0.0.1:5000/
 

	
 
If you plan to use Bitbucket_ for sending contributions, you can also fork
 
@@ -78,17 +79,15 @@ mailing list (via ``hg email``) or by cr
 
.. _contributing-tests:
 

	
 

	
 
Running tests
 
-------------
 

	
 
After finishing your changes make sure all tests pass cleanly. Install the test
 
dependencies, then run the testsuite by invoking ``py.test`` from the
 
project root::
 
After finishing your changes make sure all tests pass cleanly. Run the testsuite
 
by invoking ``py.test`` from the project root::
 

	
 
    pip install -r dev_requirements.txt
 
    py.test
 

	
 
Note that testing on Python 2.6 also requires ``unittest2``.
 

	
 
Note that on unix systems, the temporary directory (``/tmp`` or where
 
``$TMPDIR`` points) must allow executable files; Git hooks must be executable,
0 comments (0 inline, 0 general)