Skip to content

[TESTING.md] Enhance TESTING docs with Editor/IDE-Specific Tweaks & Tips #2560

@BethanyG

Description

@BethanyG

Per exercism/exercism#5791 and other comments and discussions, it has become clear that students could use some additional detail/help with setting up PyTest locally and running tests from their particular IDEs. It might also be nice to give students links to plugins or default config files to ease their setup for a given editor.

This would be for Python 3.8 and above only, and would entail changing/revising:

We can't cover all OS and IDE combinations, but we should cover the major ones if we can. In particular:

  • PyCharm (free, paid, edu) on Linux, Mac, and Windows
  • VS Code on Linux, Mac, Windows
  • Spyder on Linux, Mac, Windows
  • possibly Sublime, though lower priority
  • possibly JupyterLab, but also lower priority

Additionally, we should have tips on how things change inside a venv/conda env, how they might work inside docker, and how those methods differ from having PyTest installed globally (which is what the instructions assume at the moment). An example of some of this information given for Spyder 4.1.5 is in the comments of issue linked at the top.

Metadata

Metadata

Assignees

Labels

claimed 🐾For new exercises being written by contributors and maintainers.improve documentation 💖specific improvements to documentation on the track, the exercises, or the repo.x:action/improveImprove existing functionality/contentx:knowledge/noneNo existing Exercism knowledge requiredx:size/largeLarge amount of workx:status/claimedSomeone is working on this issuex:type/docsWork on Documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions