From: Vladimír Vondruš <mosra@centrum.cz>
Date: Wed, 2 Jan 2019 17:31:34 +0000 (+0100)
Subject: Update CONTRIBUTING for future me who will forget how to npm again.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=9c97cf838ed5e08d719cfed08745c213e4b7dd35;p=blog.git

Update CONTRIBUTING for future me who will forget how to npm again.
---

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 <https://coverage.readthedocs.io/>`_ for
-Python and `istanbul <https://istanbul.js.org/>`_ for JS. There is no
+Python (use ``pip`` or your system package) and
+`istanbul <https://istanbul.js.org/>`_ 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