aws / aws/aws-step-functions-data-science-sdk-python
Instructions in CONTRIBUTING no longer work with tox>=4
- Dominant language
- Python
- Stars
- 299
- Forks
- 84
- PR merge metrics
- No merged PRs in 30d
Description
Tox version>=4.0 is invoked differently (it's a complete rewrite from 3.x); the instructions on running unit tests in CONTRIBUTING.md no longer work.
Presumably either they should be updated to work with the current version of tox, or should be amended to specify `pip install 'tox<4'` to stay on the older version.
---
This is a 📕 documentation issue
Contributor guide
Research direction
Open CONTRIBUTING.md and find the unit-test instructions that invoke tox. Check the current tox behavior against the documented commands, then clarify the supported approach so a fresh contributor can follow the instructions successfully. Done means the CONTRIBUTING.md instructions either work with tox 4 or explicitly identify the compatible older version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100