pytest-recording docs in CONTRIBUTING.md

CONTRIBUTING.md

@@ -52,6 +52,27 @@ Use the following commands:
 
 See our GitHub Actions [`tests.yml`](.github/workflows/tests.yml) for further reference.
 
+## Using `pytest-recording` and VCR cassettes
+
+We use the [`pytest-recording`](https://github.com/kiwicom/pytest-recording) plugin
+to create VCR cassettes to cache HTTP requests,
+making our unit tests more deterministic.
+
+To record a new VCR cassette:
+
+```bash
+uv run pytest --record-mode=once tests/desired_test_module.py
+```
+
+And the new cassette(s) should appear in [`tests/cassettes`](tests/cassettes).
+
+Our configuration for `pytest-recording` can be found in [`tests/conftest.py`](tests/conftest.py).
+This includes header removals (e.g. OpenAI `authorization` key)
+from responses to ensure sensitive information is excluded from the cassettes.
+
+Please ensure cassettes are less than 1 MB
+to keep tests loading quickly.
+
 ## Additional resources
 
 For more information on contributing, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file in the repository.

tests/conftest.py

@@ -34,7 +34,6 @@ def _setup_default_logs() -> None:
 def fixture_vcr_config() -> dict[str, Any]:
     return {
         "filter_headers": [CROSSREF_HEADER_KEY, SEMANTIC_SCHOLAR_HEADER_KEY],
-        "record_mode": "none",
         "match_on": ["method", "host", "path", "query"],
         "allow_playback_repeats": True,
         "cassette_library_dir": "tests/cassettes",