diff --git a/docs/contributing.md b/docs/contributing.md index a97ddae..a32665c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,76 +1,119 @@ First, you might want to see the basic ways to [help Typer and get help](help-typer.md){.internal-link target=_blank}. -Coming soon... - - +This command generates a directory `./htmlcov/`, if you open the file `./htmlcov/index.html` in your browser, you can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing. + +### Tests in your editor + +If you want to use the integrated tests in your editor add `./docs/src` to your `PYTHONPATH` variable. + +For example, in VS Code you can create a file `.env` with: + +```env +PYTHONPATH=./docs/src +```