跳转至

问题工作流指南

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

1. 标签分类

1.1 状态标签

这些标签用于追踪 Issue 在工作流中所处的阶段。

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

1.2 类型标签

这些标签描述了 Issue 的性质。

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

1.3 优先级标签(可选)

标签 描述
high 高优先级;应在当前或下一个周期内解决
medium 普通优先级;按常规开发流程处理
low 低优先级;可推迟处理的边界情况或小问题

1.4 贡献标签(可选)

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

2. 工作流

issue_label_workflow

阶段 1 — 首次响应

当值班维护者首次接手 Issue 时:

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

阶段 2 — 分类与分析

在彻底审查 Issue 内容后:

  • 验证并应用适当的**问题类型**标签(bugfeature requestRFCquestiondocumentationinstallationperformancenew model 等)。
  • 处理终结状态:
    • 对于重复问题,应用 duplicated 标签,提供解释并链接到现有问题或 PR。如果没有进一步问题,关闭该问题。
    • 对于无效报告,提供解释,应用 invalidresolved 标签,并关闭该问题。问题创建者如有进一步问题,可以评论或请求重新打开。
  • 可选地应用**优先级**标签(highmediumlow)。
  • 如果欢迎社区贡献,应用 help wanted。对于范围明确、适合初学者的任务,同时应用 good first issue
  • 指定问题负责人,并将 triage review 替换为 triaged,以表示分类完成。

第三阶段 — 关闭

分类完成后,问题进入跟踪和实施阶段:

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