Skip to content

Commit 9ed0a92

Browse files
committed
Update dev docs
1 parent a3edc8b commit 9ed0a92

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/contributing/app-dev.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,9 @@ pytest
9797
```
9898

9999
The test code runs from the local `tests` directory. Updating code in `tests` modifies the tests.
100-
However, the tested code is the *installed* penn_chime module in your virtual environment's site-packages directory, it is *not* the code in the local `src` directory.
101-
Use `pip install .` to push your local changes in `src` to replace the installed `penn_chime` module.
100+
Use `pip install -e .` so that your local changes to `src` are also the module under test.
101+
For CI, use `pip install .` to test the module installed in site-packages to ensure that the installed module is packaged correctly with all of its dependencies.
102+
Do not import from src in your tests or your python code as this will appear to work locally, but break the python module.
102103

103104
## Validating CHIME
104105

0 commit comments

Comments
 (0)