From 8c7e9c2515e1f59e0d2dbe7371ae2505bd65c84e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Defferrard?= Date: Wed, 20 Mar 2019 13:24:14 +0100 Subject: [PATCH] contributing: extras requirement and partial test suite --- CONTRIBUTING.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f2ed7790..f18d202d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -16,6 +16,11 @@ development with the following:: $ git clone https://github.com/epfl-lts2/pygsp.git $ pip install -U -e pygsp[dev] +The ``dev`` "extras requirement" ensures that dependencies required for +development (to run the test suite and build the documentation) are installed. +Only `graph-tool `_ will be missing: install it +manually as it cannot be installed by pip. + You can improve or add functionality in the ``pygsp`` folder, along with corresponding unit tests in ``pygsp/tests/test_*.py`` (with reasonable coverage) and documentation in ``doc/reference/*.rst``. If you have a nice @@ -36,6 +41,13 @@ documentation with the following (enforced by Travis CI):: Check the generated coverage report at ``htmlcov/index.html`` to make sure the tests reasonably cover the changes you've introduced. +To iterate faster, you can partially run the test suite, at various degrees of +granularity, as follows:: + + $ python -m unittest pygsp.tests.test_docstrings.suite_reference + $ python -m unittest pygsp.tests.test_graphs.TestImportExport + $ python -m unittest pygsp.tests.test_graphs.TestImportExport.test_save_load + Making a release ----------------