From 9c97cf838ed5e08d719cfed08745c213e4b7dd35 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 2 Jan 2019 18:31:34 +0100 Subject: [PATCH] Update CONTRIBUTING for future me who will forget how to npm again. --- CONTRIBUTING.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fcae8158..ad10f1aa 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -100,7 +100,16 @@ There are no visual tests for the CSS style at the moment. Run tests: node test/test-search.js Code coverage needs `coverage.py `_ for -Python and `istanbul `_ for JS. There is no +Python (use ``pip`` or your system package) and +`istanbul `_ for JS. Install it locally using ``npm`` +to avoid polluting the whole system with crap: + +.. code:: sh + + cd doxygen + npm install istanbul + +There is no possibility of getting code coverage for Jinja2 templates, though. .. code:: sh @@ -110,7 +119,7 @@ possibility of getting code coverage for Jinja2 templates, though. # open htmlcov/index.html in your browser cd doxygen - node ./path/to/istanbul/lib/cli.js cover test/test-search.js + node ./node_modules/istanbul/lib/cli.js cover test/test-search.js # open coverage/lcov-report/index.html in your browser cd pelican-plugins -- 2.30.2