UCL-ARC / UCL-ARC/python-tooling
Add recommendation on how to run `tox` in CI
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 62
- Forks
- 10
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 6
Description
Which Section of the Documentation Needs Improving?
http://github-pages.arc.ucl.ac.uk/python-tooling/pages/testing.html#test-runners
What Can be Improved About This Section
i.e. https://github.com/tox-dev/tox-gh as introduced in #460
How to Improve This Section
No response
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
Open the testing documentation at the linked test-runners section and review tox-gh as introduced in issue #460. Update the section with a recommendation for running tox in CI; it is done when the page explains the relevant tox-gh approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation, testing
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100