Skip to content

Commit

Permalink
contributing: extras requirement and partial test suite
Browse files Browse the repository at this point in the history
  • Loading branch information
mdeff committed Mar 20, 2019
1 parent d2b25e2 commit 8c7e9c2
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://graph-tool.skewed.de>`_ 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
Expand All @@ -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
----------------

Expand Down

0 comments on commit 8c7e9c2

Please sign in to comment.