Skip to content

Commit 2cd1e0c

Browse files
author
Hugo Osvaldo Barrera
authored
Improve documentation on how to test locally (#275)
1 parent 35b1460 commit 2cd1e0c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/source/contributing.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,23 @@ The main goal of this is to simplify how many conversions we have. If we read
5858
from disk to the editor, we'd need an extra VTodo->Todo conversion code that
5959
skips the cache.
6060

61+
Running and testing locally
62+
---------------------------
63+
64+
The easiest way to run tests, it to install ``tox``, and then simply run
65+
``tox``. By default, several python versions and environments are tested. If
66+
you want to run a specific one use ``tox -e ENV``, where ``ENV`` should be one
67+
of the environments listed by ``tox -l``.
68+
69+
See the `tox`_ documentation for further details.
70+
71+
To run your modified copy of ``todoman`` without installing it, it's
72+
recommended you set up a virtualenv, and run ``pip install -e .`` to install
73+
your checked-out copy into it (this'll make ``todo`` run your local copy while
74+
the virtualenv is active).
75+
76+
.. _tox: http://tox.readthedocs.io/en/latest/
77+
6178
Patch review checklist
6279
~~~~~~~~~~~~~~~~~~~~~~
6380

0 commit comments

Comments
 (0)