Skip to content

Commit

Permalink
Added unit testing instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
mluypaert committed Mar 15, 2024
1 parent 7e9f944 commit 3fb371d
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions pipeline/seq_retrieval/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 3fb371d

Please sign in to comment.