Conversation
Added instructions for running tests in README.
There was a problem hiding this comment.
Pull request overview
Adds documentation to help contributors run the project’s test suite locally.
Changes:
- Introduces a new README section describing how to set up an environment and run tests.
- Provides a
unittestdiscovery command for executing tests undertest/.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ukbot --page Bruker:Danmichaelo/Sandkasse5 --simulate config/config.no-mk.yml | ||
|
|
||
|
|
||
| ## Howto run tests |
There was a problem hiding this comment.
Heading "Howto run tests" is grammatically incorrect/inconsistent with other sections (e.g., "Getting Started"). Consider renaming to "How to run tests" for clarity and consistency.
| ## Howto run tests | |
| ## How to run tests |
| python3 -m venv venv | ||
| source venv/bin/activate |
There was a problem hiding this comment.
These test instructions create/activate a different virtualenv path ("venv/") than the one used in "Getting Started" ("www/python/venv"). This is likely to confuse contributors; consider reusing the same path (or explicitly stating that the existing env from Getting Started can be reused) and using the same activation command style (". /bin/activate" vs "source").
| python3 -m venv venv | |
| source venv/bin/activate | |
| python3 -m venv www/python/venv | |
| . www/python/venv/bin/activate |
| python3 -m venv venv | ||
| source venv/bin/activate | ||
| pip install -r requirements.txt | ||
| pip install . |
There was a problem hiding this comment.
CI config (.travis.yml) currently runs tests via "pytest -v", but README instructs using "python3 -m unittest discover". Since this repository's tests are compatible with both, consider aligning the README with the CI command (or mention both options) to reduce confusion when reproducing CI locally.
| pip install . | |
| pip install . | |
| pytest -v | |
| If you prefer the standard library test runner, the test suite is also compatible with: |
Added instructions for running tests in README.
What type of PR is this? (check all applicable)
Tested?
Added to documentation?