Skip to content

Commit

Permalink
a few more edits to contrib.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
kafitzgerald authored Oct 3, 2023
1 parent d083663 commit c25ace9
Showing 1 changed file with 0 additions and 28 deletions.
28 changes: 0 additions & 28 deletions docs/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ A more detailed description of each step is provided in following sections.
**Make your changes**

#. `Understanding the codebase`_.
#. `Write and run tests`_.
#. :ref:`Generate <generate-docs>` and :ref:`check <check-docs>` the documentation.

**Contribute your code**
Expand Down Expand Up @@ -278,33 +277,6 @@ need to modify to incorporate your code into the package. These include:
we add to in the same PR as the code changes.


Write and run tests
-------------------

``geocat-viz`` uses `pytest <https://pytest.org/>`__ for unit tests. Currently,
we have unit tests written in both ``pytest`` and ``unittest``. We are in the
process of converting all of our tests to ``pytest`` and we encourage you to
write new tests using ``pytest``.

To run the tests locally, use the following command from the root of the
repository:

.. code-block:: bash
pytest
To run a specific test, use the following command:

.. code-block:: bash
pytest tests/test_mod.py::test_func
These tests will also run automatically when you open a pull request using
GitHub Actions and the ``.github/workflows/ci.yml`` file.

See the `pytest documentation <https://pytest.org/>`__ for more information.


*************
Documentation
*************
Expand Down

0 comments on commit c25ace9

Please sign in to comment.