最佳实践
规则放在哪里
根据规则的用途以及谁应该能够修改它,为规则选择存放位置。
选择位置
| 你想告诉 HeyDeer 什么 | 放在 | HeyDeer 从哪里读取 |
|---|---|---|
| 团队约定和项目上下文:结构、命名、应使用哪些辅助函数 | AGENTS.md | PR。嵌套的文件作用于其所在目录。 |
| 每个涉及特定文件的 PR 都必须满足的规则 | .agents/checks/ | 基础分支 |
| 多个检查共用的方法或领域知识 | .agents/skills/ | PR |
| 适用于所有仓库的审查优先事项、不必理会的内容和语气 | 组织指令 | 组织设置 → 审查指令 |
| 同上,但仅适用于一个仓库 | 仓库指令 | 仓库 →(某个仓库)→ 审查指令 |
| 仓库之外的上下文,例如工单或内部文档 | MCP 服务器 | “组织设置 → MCP 服务器”,或仓库的“MCP 服务器” |
| 哪些 PR 会被自动审查 | 自动审查筛选条件 | 审查规则 |
| 发布多少发现的问题 | 反馈范围 | 审查规则 |
| HeyDeer 撰写所用的语言 | 审查语言 | 审查规则 |
两者冲突时,审查指令优先于 AGENTS.md。
基础分支还是 PR
检查来自基础分支,因此 PR 无法削弱会被其自身改动违反的检查。新检查适用于合并后审查的 PR。
AGENTS.md 和技能来自 PR,因此它们始终与被审查的代码一致,而且任何创建 PR 的人都可以修改它们。无论 PR 怎么写都必须成立的规则,请放入检查或审查指令中。