Issue 工作流指南

Issue 工作流指南#

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

1.标签分类#

1.1状态标签#

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

标签

描述

triage review

新提交或未查看的 Issue，等待维护者进行初步评估

triaged

评估完成；已确定类型、优先级和所属模块

wait-feedback

因外部依赖阻塞，或等待回复后才能继续推进

resolved

Issue 已关闭——通过合并的 PR 解决，或通过非代码方式解决（例如：已回答问题、提供配置指导）

stale

长时间无活动；相关方已收到通知，若无回应将自动关闭

duplicated

与现有开放 Issue 或已合并 PR 重复

invalid

Issue 报告无效、不清晰或无法复现

wontfix

此 Issue 将不予处理；因其超出范围、不可行，或在可预见的未来被有意忽略

1.2类型标签#

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

标签

描述

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——首次响应#

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

  • 应用 triaged 标签表示该 Issue 可被分类，并添加相关模块标签，以便将其路由至相应的模块维护者进行详细分类。

  • 应用 triage review 标签表示该 Issue 在分类前需要更多审查和具体分析。

阶段2——分类与分析#

在彻底审查 Issue 内容后：

  • 验证并应用适当的 Issue 类型 标签（bug、feature request、RFC、question、documentation、installation、performance、new model 等）。

  • 处理终态：

    • 对于重复项，应用 duplicated 标签，提供解释并链接到现有 Issue 或 PR。若无进一步问题，则关闭该 Issue。

    • 对于无效报告，提供解释，应用 invalid 和 resolved 标签，并关闭 Issue。Issue 创建者如有进一步问题，可评论或请求重新打开。

  • 可选地应用 优先级 标签（high、medium 或 low）。

  • 如果欢迎社区贡献，应用 help wanted。对于范围明确、适合初学者的任务，同时应用 good first issue。

  • 指定 Issue 负责人，并将 triage review 替换为 triaged，表示分类已完成。

阶段3——关闭#

分类后，Issue 进入跟踪与实施阶段：

  • 保持 Issue 处于进行中状态，直至通过合并的 PR 或其他确认的解决路径得到解决。

  • Issue 解决后，应用 resolved 标签并关闭，最好附上合并的 PR 引用或简要的解决说明。

  • 如果 Issue 长时间处于非活跃状态，在自动关闭前应用 stale 作为最终状态。