Skip to content

Commit 16c11e2

Browse files
authored
Changes to contributions page (#108)
- Highlight the need for `REDIS_URL` env var - Add quotes around `pip install -e` for compatibility with all shells
1 parent 727cd76 commit 16c11e2

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Or use the local package editable install method:
3434
```bash
3535
python -m venv .venv
3636
source .venv/bin/activate
37-
pip install -e .[all,dev]
37+
pip install -e '.[all,dev]'
3838
```
3939

4040
Then to deactivate the env:
@@ -54,6 +54,8 @@ Tests (with vectorizers):
5454
make test-cov
5555
```
5656

57+
**NOTE**: Some tests require the `REDIS_URL` environment variable to be set (e.g. `export REDIS_URL=redis://localhost:6379`).
58+
5759
Tests w/out vectorizers:
5860
```bash
5961
SKIP_VECTORIZERS=true make test-cov

0 commit comments

Comments
 (0)