跳转至

问题工作流指南

本文档定义了 vLLM Ascend 项目中 问题 的标准生命周期——从创建到分诊、主动处理,再到最终关闭。它建立了统一的标签使用、负责人分配和沟通预期,以确保贡献者与维护者之间的顺畅协作。

1. 标签类别

1.1 状态标签

这些标签用于跟踪问题在工作流中的当前状态。

标签 描述
triage review 新提交或尚未查看的问题,等待维护者进行初步评估
triaged 评估完成;已确定问题类型、优先级和模块
wait-feedback 因外部依赖而阻塞,或在继续工作前等待回复
resolved 问题已关闭——通过已合并的 PR,或通过非代码方式解决(例如已回答的问题、配置指导)
stale 长时间无活动;相关方已收到通知,如果没有回复,问题将被自动关闭
duplicated 现有未关闭问题或已合并 PR 的重复项
invalid 问题报告无效、不清晰或无法复现
wontfix 该问题将不予处理;由于该问题超出范围、不可行,或在可预见的未来将被有意忽略

1.2 类型标签

这些标签用于描述问题的性质。

标签 描述
feature request 请求新功能
RFC 征求评论——需要社区讨论的重大架构或设计变更
new model 请求在 Ascend NPU 上添加对新模型的支持
usage 使用问题;可能不需要代码变更
question 一般性问题;可能不需要代码变更
documentation 文档改进或更正
installation 与设置和部署相关的问题
performance 性能回退、瓶颈或优化请求
bug 某些功能未正确工作或行为异常

1.3 优先级标签(可选)

标签 描述
high 高优先级;应在当前或下一个周期内解决
medium 正常优先级;按常规开发流程处理
low 低优先级;边缘情况或次要问题,可以延后处理

1.4 贡献标签(可选)

标签 描述
good first issue 范围明确、复杂度较低的任务,适合新贡献者
help wanted 欢迎并鼓励社区贡献

2. 工作流

issue_label_workflow

阶段 1 — 首次响应

当问题首次由值班维护者接手时:

  • 应用 triaged 以表示该问题可以分类,并添加相关模块标签,以便将问题路由到相应的模块维护者进行详细分诊。
  • 应用 triage review 以表示该问题在分类前需要更多审查和具体分析。

阶段 2 — 分诊和分析

在对问题内容进行全面审查后:

  • 核实并应用适当的 问题类型 标签(bug、feature request、RFC、question、documentation、installation、performance、new model 等)。
  • 处理终止状态:
    • 对于重复项,应用 duplicated 标签,提供说明以及现有问题或 PR 的链接。如果没有其他问题,关闭该问题。
    • 对于无效报告,提供说明,应用 invalid 和 resolved 标签,并关闭该问题。如果问题创建者有其他问题,可以评论或请求重新打开。
  • 可选地应用 优先级 标签(high、medium 或 low)。
  • 如果欢迎社区贡献,应用 help wanted。对于范围明确且适合初学者的任务,也应用 good first issue。
  • 分配问题负责人,并用 triaged 替换 triage review,以表示分诊已完成。

阶段 3 — 关闭

分诊后,问题进入跟踪和实现阶段:

  • 保持问题处于进行中状态,直到通过已合并的 PR 或其他已确认的解决路径解决。
  • 问题一旦解决,应用 resolved 并关闭,最好附上已合并 PR 的引用或对解决方案的简短说明。
  • 如果问题长时间保持不活跃,在自动关闭前应用 stale 作为最终状态。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 vl/vllm-ascend