Improve documentation for running tests
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 19
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
The current test running documentation makes some assumptions about things like docker images present. This documentation should be revisited and improved, ideally testing from a clean system and following docs exactly.
For context, see discussion in #319.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the current documentation for running tests and review the discussion in issue #319. Follow the documented process on a clean system without assuming Docker images are already present. Done means the revised instructions work from a clean setup and accurately describe the required steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100