forked from Gitlink/gitlink-cli
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# CLI 契约问题分级
|
|
|
|
把发现的问题按下面的标准分级，避免把所有问题都说成“高风险”。
|
|
|
|
## blocking
|
|
|
|
满足任一项即可：
|
|
|
|
- 删除、重命名或破坏已有 flag / 命令路径
|
|
- 破坏 `--format json` 的既有字段名或字段类型
|
|
- 引入明确的中文乱码或编码损坏
|
|
- 文档和帮助明显宣称支持，但实际命令已无法工作
|
|
- 会导致自动化脚本或既有调用方高概率失败
|
|
|
|
## high
|
|
|
|
- 新增功能影响了现有行为，但证据还不完整
|
|
- header/path/query 渲染存在高风险边界问题
|
|
- 错误提示退化，用户很难定位或修复问题
|
|
- 默认值变化会显著改变用户结果，但没有迁移说明
|
|
- 测试没有覆盖关键兼容面
|
|
|
|
## medium
|
|
|
|
- 文档、帮助、示例与实际实现有轻度漂移
|
|
- 中英文文案不同步
|
|
- 新增参数的边界行为未覆盖
|
|
- 输出是“扩展式变化”，但缺少明确验证
|
|
|
|
## low
|
|
|
|
- 文案可读性问题
|
|
- 示例可进一步收敛
|
|
- 一致性或可维护性问题
|
|
|
|
## 结论规则
|
|
|
|
- 只要存在 `blocking`，结论就是“需要修改后再合并”。
|
|
- 没有 `blocking` 但有多个 `high`，结论仍然偏向“需要补验证或修复”。
|
|
- 只有 `medium/low` 时，可以给出“可合并，但建议跟进”的结论。
|