非阻塞评论是什么
非阻塞评论是用 nit、non-blocking、optional 这类标注说明「不修也能合」的意见:可读性建议、可选优化、以后再做的小改进都在这个范围。把这类意见与必须改的问题分开标注,能救活大量卡在细节上的改动,作者也能把注意力集中到真正影响正确性的问题上。
基本信息
| 适用内容 | 可读性建议、可选优化、未来改进点 |
|---|---|
| 写法 | nit / non-blocking / optional 前置标注 |
| 配套要求 | 回复里先列必须改的,再列可选的 |
| 作者处理 | 能顺手改就改,不能改则记录为后续任务 |
使用要点
- 标注要明确:没有标注的评论会被理解为需要处理。
- 与阻塞项分开罗列:先给必须改的清单,再给可选建议。
- 作者明确不处理时说明理由即可,评审者不持续追问。
- 同一处反复出现的非阻塞建议应升级为规范或工具规则。
- 非阻塞不等于不重要:涉及后续技术风险的项要写清影响与建议时限。
标注方式与含义
| 写法 | 含义 | 处理方式 |
|---|---|---|
| nit | 小问题 | 可改可不改 |
| non-blocking | 不阻塞合并 | 作者判断,可另开任务 |
| optional | 可选改进 | 作者自主决定 |
| blocking | 必须处理 | 修完并复核后才能合并 |
怎么写才有效
- 标注写在句首:作者扫一眼评论就知道严重程度,不必读完再判断。
- 给出可执行建议:说明改成什么样,而不是只表达不喜欢。
- 与阻塞项分列:回复里先放必须改的清单,再放可选建议。
- 不处理也能接受:作者说明理由后不再追问,避免变相变成阻塞项。
- 需要后续跟进的写成任务或待办,避免随评论一起被遗忘。
明确非阻塞能救活大量卡在细节上的 PR:作者不必为一条命名建议反复等待评审者回来复核。
标了非阻塞却持续追问,等于变相阻塞:作者会无所适从,最好一次说清是否可以后续处理。