Skip to content

docs: correct the contributor test command #155

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
Hasnain2430 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: correct the contributor test command #155

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ from the contributing guide before submitting a pull request. Common checks:

```bash
uv run --no-sync ruff check .
uv run --no-sync pytest -q
uv run --no-sync python -m pytest -q
npm --prefix desktop run check
```

Expand Down
8 changes: 6 additions & 2 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,13 @@ Initialize and verify the local media runtime:
uv run --no-sync vidxp init
uv run --no-sync vidxp --version
uv run --no-sync vidxp doctor
uv run --no-sync pytest -q
uv run --no-sync python -m pytest -q
```

Run the test suite as `python -m pytest`. That form puts the repository root
on the import path, which the root-level tooling tests require. Calling
`pytest` directly fails to collect them.

`vidxp init` verifies FFmpeg, ffprobe, `libx264`, and `aac`. A fresh checkout
may report that model files have not been prepared; that is expected. Prepare
only the capability needed for manual testing:
Expand Down Expand Up @@ -143,7 +147,7 @@ Common checks are:

```bash
uv run --no-sync ruff check .
uv run --no-sync pytest -q
uv run --no-sync python -m pytest -q
npm --prefix desktop run check
docker compose config --quiet
```
Expand Down