heydeer 登录
GitHub 上的审查

解读审查结果

HeyDeer 以 GitHub PR 审查的形式发布发现的问题,并在每个问题涉及的代码行上添加行内评论。

HeyDeer 发布的内容

GitHub 上的审查没有摘要。摘要和完整的问题列表位于 HeyDeer Review 检查和 HeyDeer 中。

审查评论只包含审查警告、其他问题以及批准理由(如有)。没有内容可发布的审查不会添加评论。如果审查内容对 GitHub 来说过长,HeyDeer 会省略部分问题,并添加“在 HeyDeer 中查看全部问题”链接。

只有开启自动批准时,HeyDeer 才会批准 PR,并且不会重复讨论中已提出的问题。参见后续审查。

关闭“在 PR 中发布审查评论”后,只有检查承载审查结果。参见发布结果。

发现的问题如何排版

部分显示内容
标题严重程度和标题,例如 HIGH: 遇到 404 时重试循环不会停止。
说明问题是什么,以及会造成什么后果。
修复建议用文字说明如何修复。
建议修改精确的修改,以 GitHub 建议或只读 diff 的形式呈现。
检查提出该问题的仓库检查。
相关代码评论不在相关代码行上时,指向这些行的链接。

严重程度分为严重(Critical)、高(High)、中(Medium)和低(Low),反映的是影响,与 HeyDeer 的确信程度无关。如需发布更少或更多的问题,请更改按确信程度筛选的反馈范围。

只有当评论恰好位于它要替换的代码行上时,才会出现可以直接提交的建议;在其他位置,修改会以只读 diff 的形式呈现。HeyDeer 从不运行你的格式化工具或测试,因此提交建议前请先阅读。

GitHub 只接受 diff 中代码行上的行内评论。关于其他代码的问题(例如被此次改动破坏的未修改调用方)会放在审查评论的“其他问题”下。

审查警告

当有因素限制了审查时,审查评论、检查和 HeyDeer 中会显示“审查警告”。

警告处理方法
确信程度较低的问题已被省略每次审查保留确信程度最高的 30 个问题。请先处理这些问题,然后重新发起审查。
仅选择了前 10 个检查最多按文件名顺序应用 10 个仓库检查。请缩小它们的文件模式。
此 PR 修改了 .agents/,但新的检查配置无效请在合并前修复配置,否则 HeyDeer 将无法审查针对该分支的 PR。
部分发现的问题或讨论评估无效或不完整重新发起审查以获得完整结果。

带有警告的审查是不完整的:HeyDeer 不会批准它,它的检查不会报告成功,下一次审查会覆盖整个 PR。

审查语言

审查语言决定发现的问题、摘要、警告以及 HeyDeer 在讨论中回复所使用的语言。可选择英语(默认)、简体中文、日语、西班牙语、韩语、葡萄牙语(巴西)或德语。代码和文件路径保持原样。

可在“组织设置 → 审查规则”的“如何审查”下设置,也可以在仓库的“审查规则”中设置。

HeyDeer 中的审查

每次审查在 HeyDeer 中都有一个页面。可以从“审查记录”、检查的“Details”链接或“在 HeyDeer 中查看全部问题”打开。页面显示触发审查的原因、审查覆盖的是“新改动”还是“整个 PR”、“已用积分”、反馈范围内的每个问题,以及列在“已在讨论中决定不处理”下的疑虑。

“预览反馈范围”会显示每种反馈范围会保留哪些问题,不会改变任何内容。有写权限的人可以通过“取消审查”停止审查;已消耗的积分不会退还。