heydeer
让 HeyDeer 了解你的代码库

审查指令

审查指令告诉 HeyDeer 应优先关注什么、哪些内容不必理会,以及反馈如何措辞。指令保存在 HeyDeer 中,因此 PR 无法更改它们。

添加指令

  1. 打开工作区设置 → 审查指令。如需为单个仓库设置,请打开仓库 →(某个仓库)→ 审查指令。
  2. 使用纯文本或 Markdown 编写,最多 12,000 个字符。
  3. 选择保存工作区指令或保存此仓库指令。
  • 工作区指令适用于所有仓库。仓库指令会追加在工作区指令之后,两者冲突时以仓库指令为准。
  • 在仓库页面中,预览合并后的指令会按顺序显示两者。
  • 保存后发起的审查才会使用新内容。
  • 只有工作区管理员可以编辑指令。
  • 不要在指令中放入密码、令牌或其他机密信息。

指令中应写些什么

指令用于存放只在 HeyDeer 审查时才有意义的指导:优先关注什么、哪些内容不必理会、团队使用的术语,以及反馈如何措辞。

编码约定请放在 AGENTS.md 中,这样编程智能体也会遵循。HeyDeer 必须在每个匹配的 PR 中核实的要求,请写成仓库检查。

如果想把这类指导放在仓库里、紧挨着相关代码,请使用 REVIEW.md。PR 可以更改 REVIEW.md,所以不能让 PR 更改的内容请放在指令中。

指令优先于 REVIEW.md、AGENTS.md 和技能,但无法阻止仓库检查运行。参见指导相互冲突时。

编写有效的指令

动笔之前,先让 HeyDeer 审查几个 PR。针对反复出现的遗漏或不想要的评论添加指令,每次只加几条,再看接下来几次审查的效果。

  • 将指令归入几个标题下,例如“优先事项”“不必理会”“术语”和“反馈”。
  • 每个要点写一条指令,并写明它涉及的路径、函数和库。
  • 理由不明显时,请加以说明。
  • 排除范围要窄:写“不要评论 scripts/one-off/ 中的文件”,而不是“不要评论脚本”,后者也会掩盖真正的缺陷。
  • 报告方式请用设置调整:审查语言、反馈范围和自动批准。
## Priorities

- Code under src/payments/ is high risk. Look hardest at retries,
  refunds and anything that could charge a customer twice.

## Leave alone

- Files under scripts/one-off/. They run once by hand and are deleted.
- Formatting. The formatter runs in CI.

## Terms

- A "workspace" is a customer account, not a folder on disk.

## Feedback

- Name the input that triggers a bug, and suggest the smallest fix.

如果某条指令似乎被忽略,参见故障排除。