Skip to content

Commit 38ab160

Browse files
committed
docs: update contributing guide to reflect changes in workflows
1 parent cbe77a2 commit 38ab160

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This project requires the following tools installed:
44

55
- :simple-rust: [rust](https://rustup.rs/)
66
- :simple-uv: [`uv` (Python Project management tool)](https://docs.astral.sh/uv/)
7+
- :simple-nushell: [nushell](https://www.nushell.sh/) (for running tasks via `nur`)
78

89
## Getting started
910

@@ -14,7 +15,7 @@ uv sync
1415
```
1516

1617
This creates a venv at ".venv/" in repo root (if it doesn't exist).
17-
It also installs dev dependencies like `pre-commit`, `nox`, `ruff`, and `mypy`.
18+
It also installs dev dependencies like `pre-commit`, `ruff`, and `mypy`.
1819

1920
See [`uv sync` docs](https://docs.astral.sh/uv/reference/cli/#uv-sync)
2021
for more detailed usage.
@@ -32,47 +33,45 @@ First ensure that the following cargo-managed binaries are installed:
3233
3334
- [`cargo-llvm-cov`](https://github.com/taiki-e/cargo-llvm-cov)
3435
- [`cargo-nextest`](https://nexte.st/docs/installation/pre-built-binaries/)
35-
- [`llvm-cov-pretty`](https://crates.io/crates/llvm-cov-pretty) is used only for the optional `nox -s pretty-cov` task. Without this installed, `nox -s llvm-cov` will suffice.
36-
37-
Use nox to run tests:
36+
Use `nur` to run tests:
3837
3938
```sh
40-
uv run nox -s test
39+
nur test
4140
```
4241
4342
Different test profiles are still defined in .config/nextest.toml.
4443
The above command uses the "default" profile, but to mimic the CI, use:
4544

4645
```sh
47-
uv run nox -s test -- --profile ci
46+
nur test --profile ci
4847
```
4948

5049
To generate a coverage report:
5150

5251
```sh
53-
uv run nox -s llvm-cov -- --open
52+
nur test llvm-cov --open
5453
```
5554

56-
The `-- --open` part is optional. It opens the built coverage report in your default browser.
55+
The `--open` flag is optional. It opens the built coverage report in your default browser.
5756

5857
The uploaded codecov report is generated with
5958

6059
```sh
61-
uv run nox -s lcov
60+
nur test lcov
6261
```
6362

6463
## Generating docs
6564

6665
To view the docs locally, use
6766

6867
```sh
69-
uv run nox -s docs -- --open
68+
nur docs --open
7069
```
7170

72-
The `-- --open` part is optional. It opens the built docs in your default browser.
71+
The `--open` flag is optional. It opens the built docs in your default browser.
7372

7473
In CI, docs are built using
7574

7675
```sh
77-
uv run nox -s docs-build
76+
nur docs --build
7877
```

0 commit comments

Comments
 (0)