Skip to content

docs: fix missing pixi -e flags in CONTRIBUTING.md #1541

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

Open
gtouloumes wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −12
Open

docs: fix missing pixi -e flags in CONTRIBUTING.md #1541

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ git clone https://github.com/datajoint/datajoint-python.git
cd datajoint-python

# Run tests (containers managed automatically)
pixi run test
pixi run -e test test

# Run with coverage
pixi run test-cov
pixi run -e test test-cov

# Run pre-commit hooks
pixi run pre-commit run --all-files
pixi run -e dev pre-commit run --all-files
```

### Alternative: Using pip
Expand All @@ -41,8 +41,8 @@ Tests use [testcontainers](https://testcontainers.com/) to automatically manage
Integration tests are **backend-parameterized** — tests using the `backend` fixture run automatically against both MySQL and PostgreSQL.

```bash
pixi run test # All tests (both backends)
pixi run test-cov # With coverage
pixi run -e test test # All tests (both backends)
pixi run -e test test-cov # With coverage
pixi run -e test pytest tests/unit/ # Unit tests only
pixi run -e test pytest tests/integration/test_blob.py -v # Specific file
pixi run -e test pytest -m mysql # MySQL tests only
Expand All @@ -69,12 +69,12 @@ Tests automatically spin up both MySQL and PostgreSQL containers via testcontain
```bash
# MySQL + MinIO
docker compose up -d db minio
DJ_USE_EXTERNAL_CONTAINERS=1 pixi run test
DJ_USE_EXTERNAL_CONTAINERS=1 pixi run -e test test
docker compose down

# MySQL + PostgreSQL + MinIO
docker compose up -d db postgres minio
DJ_USE_EXTERNAL_CONTAINERS=1 pixi run test
DJ_USE_EXTERNAL_CONTAINERS=1 pixi run -e test test
docker compose down
```

Expand All @@ -91,8 +91,8 @@ docker compose --profile test up djtest --build
Hooks run automatically on `git commit`. All must pass.

```bash
pixi run pre-commit install # First time only
pixi run pre-commit run --all-files # Run manually
pixi run -e dev pre-commit install # First time only
pixi run -e dev pre-commit run --all-files # Run manually
```

Hooks include: **ruff** (lint/format), **codespell**, YAML/JSON/TOML validation.
Expand All @@ -101,9 +101,9 @@ Hooks include: **ruff** (lint/format), **codespell**, YAML/JSON/TOML validation.

## Before Submitting a PR

1. `pixi run test` — All tests pass
2. `pixi run pre-commit run --all-files` — Hooks pass
3. `pixi run test-cov` — Coverage maintained
1. `pixi run -e test test` — All tests pass
2. `pixi run -e dev pre-commit run --all-files` — Hooks pass
3. `pixi run -e test test-cov` — Coverage maintained

---

Expand Down
Loading