Code Standards

The Python code in the tests subdirectory ./tests must fulfill the following checks:

	Command	Explanation
1	ruff check tests	Python lint, format and imports check.
2	mypy tests	Objects that provide typehints pass type-checking via mypy.
3	fill	All tests must execute correctly.
4	mkdocs build --strict	Documentation generated without warnings.
5	pyspelling	Markdown spell-check.
6	markdownlint-cli2	Markdown lint check.

While this seems like a long list, a correctly configured editor (see VS Code Setup) essentially assures that all points are mostly covered.

Additionally, if you skip type hints, they won't be checked; we can help you add these in the PR.

These checks must pass in order for the execution-spec-tests Github Actions to pass upon pushing to remote.

Running the checks with tox

All these checks can be executed locally in a single command, tox, see Verifying Changes.

If you need help, get in touch!