Skip to content

Commit 2609e9f

Browse files
committed
Docs: add testing instructions for contributors
1 parent c050dfb commit 2609e9f

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,26 @@ Contribute
1717

1818
Otherwise, if you simply wants to suggest a feature or report a bug, create an issue :
1919
https://github.com/jazzband/django-pipeline/issues
20+
21+
22+
Running tests
23+
=============
24+
25+
We use tox to run the test suite on different versions locally (and travis-ci
26+
to automate the check for PRs).
27+
28+
To tun the test suite locally, please make sure your python environment has
29+
tox and django installed::
30+
31+
python3.7 -m pip install tox
32+
33+
Since we use a number of node.js tools, one should first install the node
34+
depencies. We reccomend using [nvm](https://github.com/nvm-sh/nvm#installation-and-update) , tl;dr::
35+
36+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash
37+
nvm install node
38+
nvm use node
39+
40+
And then simply execute tox to run the whole test matrix::
41+
42+
tox

0 commit comments

Comments
 (0)