Run tests in CircleCI, add pytest to dev dependencies, and update contributing guide

Author: JWCook

.circleci/config.yml

@@ -35,8 +35,14 @@ jobs:
             sudo apt-get update && sudo apt-get install pandoc
             python -m venv venv
             . venv/bin/activate
-            python -m pip install ".[sphinx]"
+            python -m pip install ".[dev,sphinx]"
             cd docs; make html
+      - run:
+          name: Run tests
+          # TODO: This coverage report could be submitted to codecov
+          command: |
+            . venv/bin/activate
+            python -m pytest --cov=src --cov-report=term --cov-report=xml
       - store_artifacts:
           path: docs/_build/html/
 

docs/dev/index.rst

@@ -25,7 +25,7 @@ Pull request guidelines
 
    ::
 
-     python -m pip install -e ".[sphinx]"
+     python -m pip install -e ".[dev,sphinx]"
 
    To build the documentation locally, use
 
@@ -52,7 +52,13 @@ Pull request guidelines
    - Re-add any changed files to your staging area and run pre-commit again to
      make sure any fixes are applied to your code.
 
-4. **Commit your changes and send your pull request as usual.**
+4. **Test Coverage**
+
+    For any new or changed behavior, please add unit test coverage. See notes in
+    `conftest.py <https://github.com/melissawm/sphinx-tags/tree/main/test/conftest.py>`__
+    for details on testing setup.
+
+5. **Commit your changes and send your pull request as usual.**
 
 Releases
 --------

pyproject.toml

@@ -17,7 +17,6 @@ keywords = [
 
 dependencies = [
     "sphinx>4",
-    "pre-commit",
 ]
 
 [project.optional-dependencies]
@@ -27,6 +26,11 @@ sphinx = [
     "nbsphinx",
     "myst-parser"
 ]
+dev = [
+    "pytest>=6.0",
+    "pytest-cov",
+    "pre-commit"
+]
 
 [project.urls]
 Home = "https://github.com/melissawm/sphinx-tags"