🙌
GitHub で全リポジトリに共通の PR テンプレートを作成する
はじめに
リポジトリごとに PR テンプレートを作るには .github/pull_request_template.md
のようなファイルを作成すればよいことは知られています。
個人開発においては、どのリポジトリも同じ PR テンプレートで良いのに毎回作らないといけないのは面倒だな🤔 と思ったので、全リポジトリ一括で同じテンプレートを使い回せないかやってみました。
やったこと
.github
リポジトリを作成
.github
リポジトリを作成し、その下に PR テンプレートファイルを作成すると、どのリポジトリでも共通のテンプレートを使用することができます(これで当初の課題は万事解決)。
.github
リポジトリにも、個別のリポジトリにも PR テンプレートがある場合
それぞれ次のようなテンプレートファイルを用意してみました。
.github リポジトリに作成したテンプレートファイル
# 概要
`.github` リポジトリにあるテンプレートファイルです。
あるリポジトリ配下に作成した .github ディレクトリ内のテンプレートファイル
# 概要
このリポジトリ用のテンプレートファイルです。
実際にこの記事(書きかけ)の PR を作成しようとしたところ、リポジトリごとに設定したテンプレートファイルの方が適用されました。
最後に
公式ドキュメントでは .github
ディレクトリのことは触れられていなさそうです(そもそもきちんと開発をする中で、どのリポジトリでも共通テンプレートを使うことはそう多くない気もしますが)。
pull request テンプレートは、リポジトリの表示されているルート ディレクトリ、docs フォルダー、または非表示の .github ディレクトリに保存できます。
この辺りの背景についても気になるところです。
Discussion