Skip to content

Docs: clarify Poetry dev install and running tests#1111

Open
Pradeep18102003 wants to merge 2 commits intomalariagen:masterfrom
Pradeep18102003:GH1097-contributing-poetry-dev
Open

Docs: clarify Poetry dev install and running tests#1111
Pradeep18102003 wants to merge 2 commits intomalariagen:masterfrom
Pradeep18102003:GH1097-contributing-poetry-dev

Conversation

@Pradeep18102003
Copy link

Fixes #1097

  • Use poetry install -E dev for installing dev/test dependencies.
  • Add quick verification for pytest-cases.
  • Clarify skipping integration tests by default and note Google ADC requirements.
  • Add small Windows/VS Code notes to reduce setup confusion.

Copilot AI review requested due to automatic review settings March 13, 2026 14:04
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates CONTRIBUTING.md to clarify the developer setup experience: it adds a Windows note about spaces in paths, swaps --extras dev for the -E dev shorthand, adds a troubleshooting tip for pytest-cases, documents how to skip integration tests, and adds a shell-environment verification step.

Changes:

  • Replaced poetry install --extras dev with poetry install -E dev and added a pytest-cases verification snippet.
  • Added --ignore=tests/integration to pytest invocations and a callout about Google ADC requirements.
  • Added Windows path-with-spaces warning and a poetry shell environment confirmation tip.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

```bash
poetry env use 3.12
poetry install --extras dev
poetry install -E dev
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Setup instructions in CONTRIBUTING.md fail with ModuleNotFoundError: pytest_cases on fresh clone

2 participants