最佳实践
有人工审查员的团队
如果每个 PR 在合并前都由人审查,请使用此配置。HeyDeer 先检查细节,让你的审查员专注于设计和产品决策。
推荐配置
创建 PR
HeyDeer 审查细节
作者修复发现的问题
审查员检查设计并合并
- 在工作区设置 → 审查规则 → 何时审查中,选择每次推送时审查。参见自动审查。
- 在发布结果下,开启发现问题时将检查标记为失败。参见 HeyDeer Review 检查。
- 在 GitHub 中 main 分支的分支规则里,将 HeyDeer Review 检查设为必需。这样,只有在 HeyDeer 审查了 PR 的最新提交,且发现的问题和此前的问题都已修复或决定不处理后,PR 才能合并。
- 请审查员在 PR 的 HeyDeer Review 检查通过后再开始阅读。这样他们就可以专注于设计、产品行为,以及 HeyDeer 在待澄清下列出的疑问。
部分检查未成功
HeyDeer Review — 审查发现了需要处理的问题必需
CI / test — 成功必需
合并已被阻止
HeyDeer 未自动审查的提交(例如 PR 已达到每个 PR 的自动审查次数上限之后的提交)也会阻止合并,直到有人发起审查。参见故障排除。
可选:自动批准常规变更
开启自动批准,并让可自动批准的 PR保持为低风险和中风险 PR。这样,没有剩余问题的常规 PR 会被 HeyDeer 批准;高风险 PR 则等人来批准,审查中会写明原因。
如果分支规则要求 1 个批准,常规 PR 无需等待审查员即可合并。请开启 Dismiss stale pull request approvals when new commits are pushed,确保每个批准都针对最新代码。
将团队标准写成检查
审查员在评论中反复提出的要求,应该写成检查。为每项要求在 .agents/checks/ 中添加一个 Markdown 文件,HeyDeer 会将它应用到每个修改了匹配文件的 PR。参见仓库检查。
.agents/checks/migrations.md
---
files: "migrations/**/*.sql"
---
The previous release keeps running while a migration
deploys. Report a migration that:
- drops or renames a table or column that code on the
base branch still uses;
- adds a NOT NULL column without a default;
- creates an index on an existing table without
CONCURRENTLY.HeyDeer 承担的工作
- 细节和边界情况。HeyDeer 会在每个 PR 上检查错误处理、边界值、并发,以及被改动破坏的调用方。
- 细节上更准确。在 1000 个内部 PR 上,HeyDeer 对细节正确性的审查比人工审查员更准确。