Skip to content

Changes to contributions page #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 1, 2024
Merged

Changes to contributions page #108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a0b6bf
Add single quotes around pip install for zsh compatibility
bsbodden Feb 1, 2024
28d73b2
Add note about REDIS_URL env var in contrib guide
bsbodden Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down