Skip to content

Commit 8f51c05

Browse files
committed
Document pyright in Contributing
1 parent 1db1121 commit 8f51c05

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

contributing/DEVELOPMENT.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,26 @@ uv sync --all-extras
2525

2626
Alternatively, if you want to manage virtual environments by yourself, you can install `dstack` into the activated virtual environment with `uv sync --all-extras --active`.
2727

28-
## 4. (Recommended) Install pre-commits:
28+
## 4. (Recommended) Install pre-commit hooks:
29+
30+
Code formatting and linting can be done automatically on each commit with `pre-commit` hooks:
2931

3032
```shell
3133
uv run pre-commit install
3234
```
3335

34-
## 5. Frontend
36+
## 5. (Recommended) Use pyright:
37+
38+
The CI runs `pyright` for type checking `dstack` Python code.
39+
So we recommend you configure your IDE to use `pyright`/`pylance` with `standard` type checking mode.
40+
41+
You can also install `pyright` and run it from the CLI:
42+
43+
```shell
44+
uv tool install pyright
45+
pyright -p .
46+
```
47+
48+
## 6. Frontend
3549

3650
See [FRONTEND.md](FRONTEND.md) for the details on how to build and develop the frontend.

0 commit comments

Comments
 (0)