heydeer
最佳实践

在团队中推广

分阶段引入 HeyDeer,等团队信任其结果后,再让它把关合并。

开始之前

每个阶段的设置由工作区管理员更改;任何有写权限的人都可以发起审查。参见工作区成员。

所有套餐均包含每月积分。新工作区使用免费套餐,首月包含 1,000 积分。所有套餐(包括免费套餐)都可以购买积分,基础价格为每 1,000 积分 $10。

积分和付款邮件会发送到工作区设置 → 通知中的邮箱。请设置为团队会查阅的邮箱,例如团队邮箱;参见通知邮箱。

阶段

  1. 可选:在团队看到之前先自己试用 HeyDeer。在工作区设置 → 审查规则 → 发布结果下,关闭发布 GitHub 检查和在 PR 中发布审查评论。通过发起审查手动发起,在审查记录页面查看结果,并在进入下一阶段前重新开启这两个选项。
  2. 先在几个 PR 上试用。完成设置后 HeyDeer 显示自定义审查方式时,关闭自动审查 PR并选择继续,让它只在有人发起时审查。然后在几个不同类型、处于打开状态的 PR 上评论 @heydeer review,并将 HeyDeer 发现的问题与审查员的意见进行比较。
  3. 补齐发现的不足。只添加这些审查表明确实需要的内容:编码约定写入 AGENTS.md,要求写成仓库检查,优先事项写入审查指令。参见 HeyDeer 读取的内容。
  4. 为一两个仓库开启自动审查:在仓库中选中它们,然后选择修改审查时机。这些仓库的审查效果符合预期后,再在工作区设置 → 审查规则 → 何时审查中设置工作区的审查时机。
  5. 切换到适合团队的配置。将 HeyDeer Review 检查设为必需,并决定是否开启自动批准。参见没有代码审查的团队或有人工审查员的团队。
  6. 设置消费控制。付费套餐可以开启自动充值并设置用量上限。参见自动充值与用量上限。
  7. 告诉团队如何与 HeyDeer 协作。分享 PR 评论命令,以及如何决定不处理发现的问题。

如果 PR 没有按预期被审查,参见故障排除。

何时进入下一阶段

当最近的审查满足以下所有条件时,进入下一阶段:

  • 团队会处理大部分发现的问题。
  • 被决定不处理的问题之间,没有可以通过审查指令或仓库检查解决的共同模式。如果有,参见减少噪音。
  • 审查完成时不带审查说明(例如提示有仓库检查未运行的说明)。

几周后,重新阅读最近的审查。把指导移到合适的位置,并删除从未影响审查结果的指令和检查。