Open
Conversation
Added instructions for running tests in README.
Contributor
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.
| 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.
Suggested change
| pip install . | |
| pip install . | |
| pytest -v | |
| If you prefer the standard library test runner, the test suite is also compatible with: |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added instructions for running tests in README.
What type of PR is this? (check all applicable)
Tested?
Added to documentation?