Mercurial > kallithea

comparison docs/contributing.rst @ 6736:1daec1628e0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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.
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Wed, 28 Jun 2017 21:24:54 +0200
parents 49be3b49c8e2
children a755bacaa725
comparison
equal deleted inserted replaced
6735:49be3b49c8e2 6736:1daec1628e0b
34 cd kallithea 34 cd kallithea
35 virtualenv ../kallithea-venv 35 virtualenv ../kallithea-venv
36 source ../kallithea-venv/bin/activate 36 source ../kallithea-venv/bin/activate
37 pip install --upgrade pip setuptools 37 pip install --upgrade pip setuptools
38 pip install -e . 38 pip install -e .
39 pip install -r dev_requirements.txt
39 gearbox make-config my.ini 40 gearbox make-config my.ini
40 gearbox setup-db -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp 41 gearbox setup-db -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp
41 gearbox serve -c my.ini --reload & 42 gearbox serve -c my.ini --reload &
42 firefox http://127.0.0.1:5000/ 43 firefox http://127.0.0.1:5000/
43 44
79 80
80 81
81 Running tests 82 Running tests
82 ------------- 83 -------------
83 84
84 After finishing your changes make sure all tests pass cleanly. Install the test 85 After finishing your changes make sure all tests pass cleanly. Run the testsuite
85 dependencies, then run the testsuite by invoking ``py.test`` from the 86 by invoking ``py.test`` from the project root::
86 project root:: 87
87
88 pip install -r dev_requirements.txt
89 py.test 88 py.test
90 89
91 Note that testing on Python 2.6 also requires ``unittest2``. 90 Note that testing on Python 2.6 also requires ``unittest2``.
92 91
93 Note that on unix systems, the temporary directory (``/tmp`` or where 92 Note that on unix systems, the temporary directory (``/tmp`` or where