heydeer
最佳实践

没有代码审查的团队

如果改动在无人阅读的情况下进入 main(例如智能体直接提交到 main,或 PR 在 CI 通过后即合并),请使用此配置。HeyDeer 审查每次推送,HeyDeer 批准后由 GitHub 合并 PR。

推荐配置

智能体创建 PR
HeyDeer 审查每次推送
检查通过,HeyDeer 批准
GitHub 合并 PR
如果 HeyDeer 报告了发现的问题,检查会失败,PR 不会合并。智能体推送修复后,HeyDeer 会审查新提交。
  1. 让智能体为每项改动推送到分支并创建 PR,而不是直接提交到 main。
  2. 在工作区设置 → 审查规则 → 何时审查中,选择每次推送时审查。参见自动审查。
  3. 在发布结果下,开启发现问题时将检查标记为失败。参见 HeyDeer Review 检查。
  4. 在发布结果下,开启自动批准。这样,一次完整的审查之后如果没有遗留发现的问题,HeyDeer 就会批准 PR。参见自动批准。
  5. 决定由谁批准高风险变更。默认情况下,高风险 PR 会等人来批准。如果也想让 HeyDeer 批准它们,请把可自动批准的 PR设为所有风险等级的 PR。
  6. 在 GitHub 中 main 分支的分支规则里,开启 Require a pull request before merging,并要求 1 个批准。同时开启 Dismiss stale pull request approvals when new commits are pushed。
  7. 在同一规则中,除 CI 检查外,再将 HeyDeer Review 检查设为必需。
  8. 在仓库的 GitHub 设置中开启 Allow auto-merge。然后为每个 PR 启用自动合并,或让智能体在创建 PR 后运行 gh pr merge --auto --squash。
HeyDeer 批准了这些变更
所有检查均已通过
HeyDeer Review — 审查完成,未发现问题
CI / test — 成功
已开启自动合并:满足所有要求后,GitHub 会合并此 PR。
HeyDeer 批准且所有必需检查都通过后,GitHub 会合并 PR。

让智能体处理发现的问题

HeyDeer 以审查的形式在 PR 上发布发现的问题,完整报告位于 HeyDeer Review 检查中。让智能体在每次推送后阅读审查、修复问题,然后再次推送。HeyDeer 随后会审查新提交。

如需决定不处理某个问题,由有写权限的人在该问题的讨论中说明决定,或将讨论标记为已解决,然后评论 @heydeer review。参见决定不处理发现的问题。

如果想改为让 HeyDeer 在独立的 PR 中修复你选择的问题,请在审查中选择用 HeyDeer 修复;参见用 HeyDeer 修复。

将团队标准写成检查

当审查会强制执行某项要求时,智能体会更可靠地满足它。为每项要求在 .agents/checks/ 中添加一个 Markdown 文件,HeyDeer 会将它应用到每个修改了匹配文件的 PR。参见仓库检查。

.agents/checks/tenant-scope.md

---
files:
  - "src/db/**/*.ts"
  - "!**/*.test.ts"
---
Every query that reads or writes customer data must be
scoped to one tenant, taken from the request context and
never from request parameters.

为什么独立审查有帮助

CI 只能发现测试覆盖到的问题。没有审查,有两类问题会被漏掉:

  • 编写代码的模型往往会认同自己的推理、忽略自己的错误,即使你要求它检查自己的工作也是如此。
  • 智能体一次次修改同一段代码时,每次改动都可能悄悄破坏之前已经正确的部分。

HeyDeer 独立于编写代码的智能体审查每个 PR,并在发布每个问题之前对照代码核实。之后再推送时,后续审查会重新检查此前的问题。