Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pytest-recording docs in CONTRIBUTING.md #410

Merged
merged 3 commits into from
Sep 16, 2024

Conversation

jamesbraza
Copy link
Collaborator

@jamesbraza jamesbraza commented Sep 14, 2024

Fixes #409

Add documentation for pytest-recording and VCR cassettes in CONTRIBUTING.md.

  • Add a section for pytest-recording plugin.
  • Link to pytest-recording documentation.
  • Provide a brief summary on how to record a new VCR using uv run pytest tests/desired_test_module.py.
  • Link to the config in tests/conftest.py.
  • Document header removals from responses.
  • Add relative links for tests/cassettes and tests/conftest.py.
  • Add a comment about keeping the cassettes less than 1 MB in size.

For more details, open the Copilot Workspace session.

Fixes #409

Add documentation for `pytest-recording` and VCR cassettes in `CONTRIBUTING.md`.

* Add a section for `pytest-recording` plugin.
* Link to `pytest-recording` documentation.
* Provide a brief summary on how to record a new VCR using `uv run pytest tests/desired_test_module.py`.
* Link to the config in `tests/conftest.py`.
* Document header removals from responses.
* Add relative links for `tests/cassettes` and `tests/conftest.py`.
* Add a comment about keeping the cassettes less than 1 MB in size.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Future-House/paper-qa/issues/409?shareId=XXXX-XXXX-XXXX-XXXX).
@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Sep 14, 2024
@jamesbraza jamesbraza self-assigned this Sep 14, 2024
@jamesbraza jamesbraza added the documentation Improvements or additions to documentation label Sep 14, 2024
CONTRIBUTING.md Outdated Show resolved Hide resolved
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 16, 2024
@jamesbraza jamesbraza merged commit 39b2108 into main Sep 16, 2024
5 checks passed
@jamesbraza jamesbraza deleted the jamesbraza/add-pytest-recording-docs branch September 16, 2024 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation in CONTRIBUTING.md for pytest-recording and VCR cassettes
2 participants