xinyun/vllm
1
0
Fork 0
mirror of https://git.datalinker.icu/vllm-project/vllm.git synced 2026-06-03 09:37:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

[Doc] update Contributing page's testing section (#18272)

Browse Source 
Signed-off-by: David Xia <david@davidxia.com>
This commit is contained in:
David Xia 2025-07-29 13:32:46 -04:00 committed by GitHub
parent f03e9cf2bb
commit 7b49cb1c6b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/contributing/README.md
View File

@ -26,6 +26,8 @@ See <gh-file:LICENSE>.
## Developing ## Developing
--8<-- "docs/getting_started/installation/python_env_setup.inc.md"
Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation.
Check out the [building from source][build-from-source] documentation for details. Check out the [building from source][build-from-source] documentation for details.
@ -42,7 +44,7 @@ For an optimized workflow when iterating on C++/CUDA kernels, see the [Increment
Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blob/main/mkdocs.yaml) used in the vLLM documentation, as well as required dependencies: Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blob/main/mkdocs.yaml) used in the vLLM documentation, as well as required dependencies:
```bash ```bash
pip install -r requirements/docs.txt uv pip install -r requirements/docs.txt
``` ```
!!! note !!! note
@ -98,13 +100,14 @@ For additional features and advanced configurations, refer to the official [MkDo
??? console "Commands" ??? console "Commands"
```bash ```bash
pip install -r requirements/common.txt -r requirements/dev.txt # These commands are only for Nvidia CUDA platforms.
uv pip install -r requirements/common.txt -r requirements/dev.txt --torch-backend=auto
# Linting, formatting and static type checking # Linting, formatting and static type checking
pre-commit install --hook-type pre-commit --hook-type commit-msg pre-commit install
# You can manually run pre-commit with # You can manually run pre-commit with
pre-commit run --all-files pre-commit run --all-files --show-diff-on-failure
# To manually run something from CI that does not run # To manually run something from CI that does not run
# locally by default, you can run: # locally by default, you can run:
@ -122,6 +125,10 @@ For additional features and advanced configurations, refer to the official [MkDo
Therefore, we recommend developing with Python 3.12 to minimise the chance of your local environment clashing with our CI environment. Therefore, we recommend developing with Python 3.12 to minimise the chance of your local environment clashing with our CI environment.
!!! note "Install python3-dev if Python.h is missing"
If any of the above commands fails with `Python.h: No such file or directory`, install
`python3-dev` with `sudo apt install python3-dev`.
!!! note !!! note
Currently, the repository is not fully checked by `mypy`. Currently, the repository is not fully checked by `mypy`.
@ -153,7 +160,7 @@ Using `-s` with `git commit` will automatically add this header.
!!! tip !!! tip
You can enable automatic sign-off via your IDE: You can enable automatic sign-off via your IDE:
- **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window. - **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window.
It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`. It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`.
- **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings) - **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings)