From 5a0b6bf4dc33a34ff36a7aea7f2ba808fd60c74d Mon Sep 17 00:00:00 2001 From: Brian Sam-Bodden Date: Thu, 1 Feb 2024 11:25:27 -0700 Subject: [PATCH 1/2] Add single quotes around pip install for zsh compatibility --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1aa57a4d..ee9f249f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ Or use the local package editable install method: ```bash python -m venv .venv source .venv/bin/activate -pip install -e .[all,dev] +pip install -e '.[all,dev]' ``` Then to deactivate the env: From 28d73b282054427b20202ea11871445c01a513ec Mon Sep 17 00:00:00 2001 From: Brian Sam-Bodden Date: Thu, 1 Feb 2024 11:33:52 -0700 Subject: [PATCH 2/2] Add note about REDIS_URL env var in contrib guide --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee9f249f..d4dd0c14 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,6 +54,8 @@ Tests (with vectorizers): make test-cov ``` +**NOTE**: Some tests require the `REDIS_URL` environment variable to be set (e.g. `export REDIS_URL=redis://localhost:6379`). + Tests w/out vectorizers: ```bash SKIP_VECTORIZERS=true make test-cov