跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.devin.ai/llms.txt

Use this file to discover all available pages before exploring further.

Pull Request 模板

Devin 可以使用 GitHub 风格的 pull request 模板。它会在你的代码库中查找首个匹配的模板文件,并在生成或重新生成 PR 描述时使用该模板。除了标准的 GitHub 文件名之外,Devin 还支持一个 Devin 专用的变体,这样你就可以为 Devin 提供与人工作者使用的模板不同的版本。

1. 查找顺序

自上而下,先匹配者生效:
PULL_REQUEST_TEMPLATE/DEVIN_PR_TEMPLATE.md
docs/PULL_REQUEST_TEMPLATE/DEVIN_PR_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE/DEVIN_PR_TEMPLATE.md
PULL_REQUEST_TEMPLATE/devin_pr_template.md
docs/PULL_REQUEST_TEMPLATE/devin_pr_template.md
.github/PULL_REQUEST_TEMPLATE/devin_pr_template.md
PULL_REQUEST_TEMPLATE.md
pull_request_template.md
docs/PULL_REQUEST_TEMPLATE.md
docs/pull_request_template.md
.github/PULL_REQUEST_TEMPLATE.md
.github/pull_request_template.md
名为 DEVIN_PR_TEMPLATE.mddevin_pr_template.md 的文件是可选的 Devin 专用覆盖模板(同时支持大写和小写两种文件名形式)。如果这两个文件都不存在,则会使用标准的 PULL_REQUEST_TEMPLATE.mdpull_request_template.md 位置。若仍未匹配到任何文件,Devin 会回退到其内置的默认结构。

2. 自定义 Devin 模板(可选)

通过创建以下任一文件来添加一个仅供 Devin 使用的模板:
.github/PULL_REQUEST_TEMPLATE/DEVIN_PR_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE/devin_pr_template.md
docs/PULL_REQUEST_TEMPLATE/DEVIN_PR_TEMPLATE.md
docs/PULL_REQUEST_TEMPLATE/devin_pr_template.md
PULL_REQUEST_TEMPLATE/DEVIN_PR_TEMPLATE.md
PULL_REQUEST_TEMPLATE/devin_pr_template.md
如果你希望 Devin 在不改变用户在常规 PULL_REQUEST_TEMPLATE.mdpull_request_template.md 中看到内容的前提下,额外包含一些结构(例如风险检查清单提示),可以使用这种方式。大写和小写两种文件名形式都受支持。 如果你更偏好使用单一的共享模板,只需保留(或添加):
.github/pull_request_template.md
占位符和 HTML 注释会自动清理。

3. 内置默认模板(未找到文件时)

如果没有模板文件,Devin 会使用一个内置默认模板,其中包含以下部分:
  • Summary(摘要)
  • Review & Testing Checklist(评审与测试清单)
  • (可选)Mermaid diagram(Mermaid 图)
  • Notes(备注)
除非你需要自定义,否则无需复制此模板;只要提供上述任一受支持的文件,即可完全替换该默认模板。

4. GitHub 参考

Devin 遵循 GitHub 的单文件模板解析规则。有关 GitHub PR 模板(包括多模板工作流)的更多信息,请参见此处
最小配置,使 Devin 拥有自己的专属模板:
mkdir -p .github/PULL_REQUEST_TEMPLATE
echo "# [title]\n\n## Summary\n...\n" > .github/PULL_REQUEST_TEMPLATE/devin_pr_template.md
就可以了——打开或重新生成一个 PR,Devin 就会使用它。