Skip to content

Commit

Permalink
add instructions to run tests
Browse files Browse the repository at this point in the history
  • Loading branch information
masci committed Nov 10, 2023
1 parent 45a4162 commit c81514a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,27 @@ When your custom document store is ready and working, feel free to add it to the
[this repo](https://github.com/deepset-ai/haystack-integrations).


## Testing

You can use `hatch` to run the linters:

```console
~$ hatch run lint:all
cmd [1] | ruff .
cmd [2] | black --check --diff .
All done! ✨ 🍰 ✨
6 files would be left unchanged.
cmd [3] | mypy --install-types --non-interactive src/example_store tests
Success: no issues found in 6 source files
```

Similar for running the tests:

```console
~$ hatch run cov
cmd [1] | coverage run -m pytest tests
...
```
## License

`example-store` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

0 comments on commit c81514a

Please sign in to comment.