最佳实践
在团队中推广
分阶段引入 HeyDeer,等团队信任其结果后,再让它把关合并。
阶段
- 先在几个 PR 上试用。新工作区默认使用“仅手动”。在几个近期、不同类型的 PR 上评论 @heydeer review,并将发现的问题与你们审查员的意见进行比较。
- 补齐发现的不足。只添加这些审查表明确实需要的内容:约定、必须始终成立的规则和优先事项。参见规则放在哪里。
- 开启自动审查。先在一两个仓库上使用“每个 PR 审查一次”,然后改为“每次推送时审查”并设置“每个 PR 的自动审查次数上限”,再设置组织的审查时机。参见自动审查。
- 发布检查,但先不以它把关。默认情况下,即使审查发现问题,HeyDeer Review 检查也会通过。在团队适应发现的问题期间,保持这一设置。
- 团队信任后,将检查设为必需。在 GitHub 分支规则中将 HeyDeer Review 设为必需检查,然后开启“发现问题时将检查标记为失败”。此后,未被自动审查的版本会等待 @heydeer review。参见 HeyDeer Review 检查。
- 决定是否自动批准。该功能默认关闭。如果开启,建议先使用“仅简单改动”,并在分支规则中撤销过时的批准。参见自动批准。
- 设置通知和消费控制。添加工作区邮箱以接收积分和试用通知,并开启自动充值、设置用量上限。参见通知和自动充值与用量上限。
- 告诉团队如何与 HeyDeer 协作。分享 PR 评论命令、如何通过回复决定不处理发现的问题,以及如何编写易于审查的 PR。
检查清单
- 已在“仅手动”模式下审查了几个真实的 PR
- 已针对这些审查遗漏的内容添加 AGENTS.md、检查或指令
- 已标记生成文件,并过滤掉机器人 PR
- 已开启“每个 PR 审查一次”,然后改为带审查次数上限的“每次推送时审查”
- 已发布 HeyDeer Review 检查,但发现问题时不标记为失败
- 已决定是否将检查设为必需,以及发现问题时是否标记为失败
- 已决定是否自动批准
- 已设置通知邮箱、自动充值和用量上限
- 已分享命令以及如何决定不处理发现的问题
几周后,重新阅读最近的审查,移动放错位置的规则,并删除不起作用的规则。