Context
The CONTRIBUTING.md file tells contributors to run tests with pytest test/ -v, but the actual test directory is named tests/ (with an "s"). This causes confusion and command failures for new contributors following the guide.
Steps to reproduce
- Open
CONTRIBUTING.md.
- Find the test commands in sections "Getting Started" (step 4) and "Making Changes" (step 3).
- Both say
pytest test/ -v.
- Run:
pytest test/ -v -- this fails because the directory does not exist.
Expected behavior
The commands should reference the correct directory: pytest tests/ -v.
Actual behavior
The commands reference pytest test/ -v which does not exist.
Files
CONTRIBUTING.md -- two occurrences of pytest test/ -v
Acceptance criteria
Suggested approach
- Open
CONTRIBUTING.md.
- Find and replace
pytest test/ with pytest tests/ (there are 2 occurrences).
- Verify by reading through the file that the instructions make sense.
Context
The
CONTRIBUTING.mdfile tells contributors to run tests withpytest test/ -v, but the actual test directory is namedtests/(with an "s"). This causes confusion and command failures for new contributors following the guide.Steps to reproduce
CONTRIBUTING.md.pytest test/ -v.pytest test/ -v-- this fails because the directory does not exist.Expected behavior
The commands should reference the correct directory:
pytest tests/ -v.Actual behavior
The commands reference
pytest test/ -vwhich does not exist.Files
CONTRIBUTING.md-- two occurrences ofpytest test/ -vAcceptance criteria
pytest test/inCONTRIBUTING.mdare changed topytest tests/Suggested approach
CONTRIBUTING.md.pytest test/withpytest tests/(there are 2 occurrences).