メインコンテンツへスキップ

プルリクエストテンプレート

Devin は GitHub 形式のプルリクエストテンプレートを使用できます。リポジトリ内で最初に一致するテンプレートファイルを検索し、PR の説明を生成または再生成する際にそれを使用します。標準的な GitHub のファイル名に加えて、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.md および pull_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
通常の PULL_REQUEST_TEMPLATE.md または pull_request_template.md に人間が見る内容の変更を加えずに、Devin に追加の構造(例:リスクチェックリストのヒント)を含めさせたい場合に使用します。ファイル名は大文字・小文字どちらの表記にも対応しています。 単一の共有テンプレートを使いたい場合は、次をそのまま維持するか(または追加)してください:
.github/pull_request_template.md
プレースホルダーと HTML コメントは自動的に整理されます。

3. 組み込みデフォルト(ファイルが見つからない場合)

テンプレートファイルが存在しない場合、Devin は内部のデフォルトテンプレートを使用し、次のセクションを含みます:
  • Summary
  • Review & Testing Checklist
  • (任意)Mermaid diagram
  • 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 がその PR を利用します。