贡献指南#
构建与测试#
建议在提交拉取请求（PR）之前，先搭建本地开发环境来构建 vllm-ascend 并运行测试。
搭建开发环境#
理论上，vllm-ascend 的构建仅支持 Linux 系统，因为其依赖项 torch_npu 仅支持 Linux。
但您仍可在 Linux/Windows/macOS 上搭建开发环境，用于代码规范检查（linting）和运行基础测试。
本地代码规范检查#
# Choose a base dir (~/vllm-project/) and set up venv
cd ~/vllm-project/
python3 -m venv .venv
source ./.venv/bin/activate
# Clone vllm-ascend and install
git clone https://github.com/vllm-project/vllm-ascend.git
cd vllm-ascend
# Install lint requirement and enable pre-commit hook
pip install -r requirements-lint.txt
# Run lint (You need to install pre-commits deps via proxy network at first time)
bash format.sh
本地运行 CI 测试#
完成“本地代码规范检查”的环境搭建后，您可在本地运行 CI 测试：
cd ~/vllm-project/
# Run CI needs vLLM installed
git clone --branch v0.20.2 https://github.com/vllm-project/vllm.git
cd vllm
pip install -r requirements/build.txt
VLLM_TARGET_DEVICE="empty" pip install .
cd ..
# Install requirements
cd vllm-ascend
# For Linux:
pip install -r requirements-dev.txt
# For non-Linux:
cat requirements-dev.txt | grep -Ev '^#|^--|^$|^-r' | while read PACKAGE; do pip install "$PACKAGE"; done
cat requirements.txt | grep -Ev '^#|^--|^$|^-r' | while read PACKAGE; do pip install "$PACKAGE"; done
# Run ci:
bash format.sh ci
提交更改#
# Commit changed files using `-s`
git commit -sm "your commit info"
🎉 恭喜！您已完成开发环境的搭建。
本地测试#
您可以参考 测试指南 来搭建测试环境并在本地运行测试。
开发者来源认证（DCO）与签名确认#
向本项目提交贡献时，您必须同意开发者来源认证（DCO）。提交（commit）必须包含 Signed-off-by: 头部，以证明您同意 DCO 的条款。
使用 git commit -s 命令会自动添加此头部信息。
PR 标题与分类#
只有特定类型的拉取请求（PR）会被审核。PR 标题应使用合适的前缀来标明变更类型。请使用以下前缀之一：
[Attention]：注意力机制相关的新功能或优化。[Communicator]：通信器相关的新功能或优化。[ModelRunner]：模型运行器相关的新功能或优化。[Platform]：平台相关的新功能或优化。[Worker]：工作进程（worker）相关的新功能或优化。[Core]：vllm-ascend 核心逻辑（如平台、注意力机制、通信器、模型运行器）中的新功能或优化。[Kernel]：影响计算内核和算子的更改。[BugFix]：错误修复。[Doc]：文档修复与改进。[Test]：测试相关（如单元测试）。[CI]：构建或持续集成的改进。[Misc]：不适用于上述类别的 PR。请谨慎使用此类别。
备注
如果 PR 涉及多个类别，请包含所有相关的前缀。
其他信息#
您可以在 docs.vllm.ai 上找到有关为 vLLM Ascend 后端插件贡献的更多信息。如果在贡献过程中遇到任何问题，欢迎随时提交 PR 来改进文档，以帮助其他开发者。