已合并
docs: add introduce for issue check #49
drizzlezyk创建于 4月15日
docs: add introduce for issue check #49
已合并
共 1 个文件变更+39-0
| @@ -86,6 +86,45 @@ graph LR | |||
| 86 | | `[Usage]` | `usage` | 标记为用户使用咨询、常见问题探讨。 | | 86 | | `[Usage]` | `usage` | 标记为用户使用咨询、常见问题探讨。 | |
| 87 | | `[Roadmap]` | `roadmap` | 标记为项目路线图、阶段性规划相关 Issue。 | | 87 | | `[Roadmap]` | `roadmap` | 标记为项目路线图、阶段性规划相关 Issue。 | |
| 88 | 88 | ||
| 89 | +## Issue描述质量检测助手 | ||
| 90 | + | ||
| 91 | +Issue描述质量检测助手 是社区 Issue 的描述质量助手。它会自动评估提交内容是否“可处理”，并给出清晰反馈，帮助用户一次性补齐关键信息，减少维护者来回追问。 | ||
| 92 | + | ||
| 93 | +#### 1. 自动识别问题类型 | ||
| 94 | +- 自动识别 Bug、Doc、Installation、Usage等常见类型。 | ||
| 95 | +- 支持 Issue 场景。 | ||
| 96 | +- 不同类型按对应标准评估，反馈更贴合实际问题。 | ||
| 97 | + | ||
| 98 | +#### 2. 一次给出可执行反馈 | ||
| 99 | +- 告诉你当前描述是否基本合格。 | ||
| 100 | +- 指出缺失了哪些关键信息（如环境、复现条件、关键日志）。 | ||
| 101 | +- 给出可直接照做的补充建议，而不是泛泛而谈。 | ||
| 102 | +- 输出评分与结论，方便维护者快速分流处理优先级。 | ||
| 103 | + | ||
| 104 | +#### 3. 提升社区协作效率 | ||
| 105 | + | ||
| 106 | +- 让新人更容易提交高质量 Issue。 | ||
| 107 | +- 让维护者把时间用在问题定位和修复，而不是收集基础信息。 | ||
| 108 | +- 在大规模社区里保持更一致的描述评审标准。 | ||
| 109 | + | ||
| 110 | +### 适用场景 | ||
| 111 | +- 新 Issue 提交后的自动质量检查。 | ||
| 112 | +- 社区维护者的日常分流和处理提效。 | ||
| 113 | + | ||
| 114 | +```mermaid | ||
| 115 | +flowchart TD | ||
| 116 | + A[提交 Issue 标题/描述] --> B[Issue描述质量检测助手 判定] | ||
| 117 | + B --> C{是否合格} | ||
| 118 | + C -->|合格| D[正常后续处理] | ||
| 119 | + C -->|不合格| E[给出缺失项与修改提示] | ||
| 120 | + E --> F[用户修改标题/描述] | ||
| 121 | + F --> G[再次判定] | ||
| 122 | + G --> C | ||
| 123 | +``` | ||
| 124 | + | ||
| 125 | +如需扩展到新问题类型，可按社区规范补充对应模板，机器人会沿用同样的评估与反馈机制。 | ||
| 126 | + | ||
| 127 | + | ||
| 89 | ## 规则新增与维护说明 | 128 | ## 规则新增与维护说明 |
| 90 | ### 机器人 Issue 自动处理规则 | 129 | ### 机器人 Issue 自动处理规则 |
| 91 | 机器人 Issue 自动处理规则（包括标签名称、超时时间、评论内容及标题打标映射）统一在 [bot-issue-manage.yaml](../../config/bot-issue-manage.yaml) 配置文件中进行维护。 | 130 | 机器人 Issue 自动处理规则（包括标签名称、超时时间、评论内容及标题打标映射）统一在 [bot-issue-manage.yaml](../../config/bot-issue-manage.yaml) 配置文件中进行维护。 |