From 3fb371dda0af6624cb893149a7bbcd670207681c Mon Sep 17 00:00:00 2001 From: Manuel Luypaert Date: Fri, 15 Mar 2024 13:18:41 +0000 Subject: [PATCH] Added unit testing instructions to README --- pipeline/seq_retrieval/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/pipeline/seq_retrieval/README.md b/pipeline/seq_retrieval/README.md index 38a99614..d28dd118 100644 --- a/pipeline/seq_retrieval/README.md +++ b/pipeline/seq_retrieval/README.md @@ -138,3 +138,16 @@ These style checks are automatically run and enforced as part of the PR validati and all reported errors must be fixed to enable merging each PR into `main`. If the `pipeline/seq_retrieval python style check` status check fails on a PR in github, click the details link and inspect the failing step output for hints on what to fix. + +#### Unit testing +[Pytest](https://pytest.org/) is being used for unit testing. + +To run unit testing locally, run the following command: +```shell +make run-unit-tests +``` + +All unit tests are automatically run and enforced as part of the PR validation +and all reported errors must be fixed to enable merging each PR into `main`. +If the `pipeline/seq_retrieval unit tests` status check fails on a PR in github, +click the details link and inspect the failing step output for hints on what to fix.