最佳实践
减少噪音
如果 HeyDeer 发布的内容超出了团队愿意阅读的量,请在下面找到对应的噪音类型并采用相应的解决办法。越靠前的行,花费的精力越少,效果越明显。
解决办法
| 噪音 | 解决办法 | 详情 |
|---|---|---|
| 太多你不会处理的问题 | 将“反馈范围”切换为“精简”。如需先比较不同范围,请在 HeyDeer 中打开最近的一次审查,使用“预览反馈范围”。 | 反馈范围 |
| 对生成代码的评论 | 在基础分支的 .gitattributes 中将这些文件标记为 linguist-generated。 | HeyDeer 读取的内容 |
| 对机器人或临时 PR 的审查 | 添加自动审查筛选条件,例如“作者账号类型 → 不是以下任意一项 → 机器人”,或“PR 标签 → 不是以下任意一项 → 跳过审查”。 | 审查筛选条件 |
| 你决定不修复的问题 | 回复说明理由,或将讨论标记为已解决。有写权限的人做出的决定会让 HeyDeer 不再提出该问题。 | 后续审查 |
| 某类没人处理的评论 | 在审查指令或 AGENTS.md 中,说明哪些内容不要评论,范围要窄,并给出理由。避免“不要评论性能”这类宽泛的规则。 | 编写审查指导 |
| 检查在与其无关的文件上触发 | 缩小其 files 模式,并排除测试或测试夹具。 | 编写有效的检查 |
| 每次推送都进行后续审查 | 保持“只审查新改动”开启,并设置“每个 PR 的自动审查次数上限”,或使用“每个 PR 审查一次”。 | 自动审查 |
| PR 对话过长 | 保持“将已处理的 HeyDeer 讨论标记为已解决”开启,或关闭“在 PR 中发布审查评论”,让 HeyDeer Review 检查承载审查结果。 | 发布结果 |
示例
.gitattributes 中的生成文件:
src/generated/** linguist-generated
*.pb.go linguist-generated=true关于哪些内容不必理会的窄范围规则:
## Leave alone
- Files under scripts/one-off/. They run once by hand and are deleted.
- Missing input validation in internal/admin-cli/. It only runs
locally with trusted input.