diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9245da8d..b264c6179 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,8 @@ Please format and test your code! I know it's a hassle, but it makes sure that y To test your code, execute `pytest` in the src/ directory. This also generates a html coverage report, which you can use to see if you missed anything important during testing. +Before you can run `pytest`, ensure to [properly set up your local environment](https://paperless-ngx.readthedocs.io/en/latest/extending.html#initial-setup-and-first-start). + ## More info: ... is available in the documentation. https://paperless-ngx.readthedocs.io/en/latest/extending.html