Skip to content

Commit

Permalink
add some more text in the steps
Browse files Browse the repository at this point in the history
  • Loading branch information
wd60622 committed Oct 6, 2023
1 parent 20b6cf3 commit 26d13f2
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Setup local development environment
#. Build the docs locally

Our docs are built with Sphinx. To build the docs locally:

.. code-block:: bash
make docs.build
Expand All @@ -63,6 +65,8 @@ Setup local development environment
#. Run the tests

The unit tests are run with ``unittest`` via ``tox``. To run the tests locally:

.. code-block:: bash
make test
Expand All @@ -72,7 +76,9 @@ Setup local development environment
Pull Request checklist
----------------------

- Passing tests
- pre-commit hooks passing
- Docstring and examples and checking for correct rendering in the docs
Please check that your pull request meets the following criteria:

- Unit tests pass
- pre-commit hooks pass
- Docstring and examples and checking for correct render in the docs

0 comments on commit 26d13f2

Please sign in to comment.