Improve documentation for testing and the Process test suite
Open
@timothy-nunn is already working on this.
Since Jul 7, 2023.
Documentation
- Dominant language
- Python
- Stars
- 71
- Forks
- 27
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 33
Description
In GitLab by @timothy-nunn on Feb 1, 2022, 09:32
In discussion with @j-a-foster yesterday, it was clear that the --overwrite flag could benefit from additional information in their documentation.
I propose the following changes to the documentation around testing:
- A page/section around writing tests
- A page/section around using Pytest (e.g. -k)
- A page/section around using the Process test suite (e.g. overwrite and tolerance), updating hardcoded tests, and how to tell if your regression/integration failures are acceptable.
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.
Assessment
This issue has not been assessed yet.