GitHubのプルリクテンプレートが反映されていない場合に疑うこと

こんにちは。shootaceanです。

個人開発を楽にするためにGitHubのプルリクテンプレートを作成した際、ファイルを追加してもなぜか利用できないことがあったので、試したことを残しておきます。

最初につくったテンプレート

公式ドキュメントを参考に ./.github/PULL_REQUEST_TEMPLATE/default.md というディレクトリ構成でテンプレートファイルを作成しました。

リポジトリ用のプルリクエストテンプレートの作成 - GitHub Docs

上記のように PULL_REQUEST_TEMPLATE ディレクトリ配下にテンプレートファイルを置いても、GitHubからプルリクを作成する場合は利用されませんでした。

試してはいないのですが、公式ドキュメントでしっかり説明されているように、クエリパラメータでテンプレートを指定した場合のみ利用できるテンプレートなのだと思います。

サポートしているどのフォルダーでも PULL_REQUEST_TEMPLATE/ サブディレクトリを作成し、pull request テンプレートを複数含めることができます。また、template クエリ パラメーターで pull request の本文に使用するテンプレートを指定できます。 詳細については、「クエリ パラメーターを使用して pull request を作成する」を参照してください。

Web上でプルリクを作成するなら ./github/pull_request_template.md だけでよい

私の利用用途であればシンプルにWeb上からプルリクを作成するだけなので、複数種類のテンプレートは不要です。
なので、./github/pull_request_template.md だけで十分でした。

まとめ

個人開発で自分しか利用しない場合でもプルリクやIssueのテンプレートを用意すれば、やることの整理などを行ってスムーズに開発ができるようになるので、テンプレート化はおすすめです！