Repository navigation
docs: fix missing pixi -e flags in CONTRIBUTING.md - #1541
Merged
dimitri-yatsenko merged 1 commit intoAug 14, 2026
Merged
dimitri-yatsenko merged 1 commit into
dimitri-yatsenko merged 1 commit into
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Every quickstart command (`pixi run test`, `test-cov`, `pre-commit ...`) omitted `-e <environment>`, so it resolved to the `default` pixi environment, which only installs bare `datajoint` — no pytest or pre-commit. Following the doc verbatim on a clean clone fails with `pytest: command not found` / `pre-commit: command not found`. Add `-e test` to the test/test-cov invocations and `-e dev` to the pre-commit invocations, matching the already-correct `-e test` usage further down in the same doc and how CI itself invokes pixi (.github/workflows/test.yaml).
dimitri-yatsenko
approved these changes
Aug 14, 2026
dimitri-yatsenko
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Verified against pyproject.toml: test/test-cov are global [tool.pixi.tasks], so a bare pixi run test runs in the default environment, whose base deps are just editable datajoint — pytest/pre-commit are in the test/dev features only. So bare pixi run test does fail with pytest: command not found, and the fix matches CI (pixi run -e <env> …). Correctly adds -e test to the test tasks and -e dev to pre-commit (pre-commit is in the dev feature), and only touches the bare commands. Clean doc fix — thanks @gtouloumes!
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Every top-level pixi run command in the Quick Start and "Before Submitting
a PR" sections (pixi run test, pixi run test-cov, pixi run pre-commit ...) omits -e <environment>. Without it, pixi resolves the task against
the default environment, which only installs the bare datajoint package
([tool.pixi.pypi-dependencies]) — pytest and pre-commit only exist in the
test/dev feature environments. Following the Quick Start verbatim on a
clean clone fails on the very first command:
This also left the doc inconsistent with itself (the finer-grained examples
a few lines down already use -e test, e.g. pixi run -e test pytest tests/unit/) and with CI, which always calls pixi run -e <env> ...
(.github/workflows/test.yaml:55,70), never a bare pixi run <task>.
What
(Quick Start, Running Tests, External Containers, Before Submitting a PR)
(Quick Start, Pre-commit Hooks, Before Submitting a PR)
Test plan
previously failed with pytest: command not found)