chiark / gitweb /
Update CONTRIBUTING for future me who will forget how to npm again.
authorVladimír Vondruš <mosra@centrum.cz>
Wed, 2 Jan 2019 17:31:34 +0000 (18:31 +0100)
committerVladimír Vondruš <mosra@centrum.cz>
Wed, 2 Jan 2019 21:25:05 +0000 (22:25 +0100)
CONTRIBUTING.rst

index fcae81583f4b31abefb641dd5d22be94f5d75910..ad10f1aa77a68774a3d89c6b134535d6ef886079 100644 (file)
@@ -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