From 62fb1e29a7e6e66d3c1932bf250266eadda891cf Mon Sep 17 00:00:00 2001 From: Bruno Enten Date: Sat, 8 Jun 2024 10:59:35 +0200 Subject: [PATCH] Add tests requirements installation information (#1865) Co-authored-by: Franck Nijhof --- docs/development_testing.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/development_testing.md b/docs/development_testing.md index f0815813..f86131fc 100644 --- a/docs/development_testing.md +++ b/docs/development_testing.md @@ -2,13 +2,15 @@ title: "Testing your code" --- -As it states in the [Style guidelines section](development_guidelines.md) all code is checked to verify the following: +As stated in the [Style guidelines section](development_guidelines.md) all code is checked to verify the following: - All the unit tests pass - All code passes the checks from the linting tools Local testing is done using [pytest](https://docs.pytest.org/) and using [pre-commit](https://pre-commit.com/) for running out linters, which has been installed as part of running `script/setup` in the [virtual environment](development_environment.mdx). +Python test requirements need to be installed before tests can be run. This can be achieved by using the VScode devcontainer and the corresponding task. Check the [devcontainer documentation](/docs/development_environment#tasks) for guidance about running tasks. + To run our linters, on the full code base, run the following command: ```shell