GitBucketにプルリクエストを作成する際、
手動で確認事項を書き忘れたことが発生してしまいましたので、
プルリクエストのテンプレートを設定する方法を調査しました。
その設定メモを残ります。
プルリクエストのテンプレート作成
前提条件として、Gitのリポジトリを用意しています。
作成方法は以下の二つがあります。
方法①
リポジトリのルートディレクトリにテンプレートファイルを配置する
例:pull_request_template.md
ファイルの中:
## 概要
このプルリクエストは、「どういう作業、変更を行う」を記載。
## テスト方法、確認した内容
テストした内容や、確認した内容を記載。
## TODO
このPull Requestに対して、後続で発生する積み残し作業などがある場合は記載。
これで、テンプレートを設定できました。
新しいプルリクエストを作成する際、上記のテンプレートが生成されると思います。
Githubの方は、サンプル1を用意しましたので、ご参考まで。
方法②
リポジトリの特定のフォルダ配下に、テンプレートファイルを配置する
GitBucketの場合、「.gitbucket」フォルダにコピー
Githubの場合、「.github」フォルダにコピー
Githubの方は、サンプル2を用意しましたので、ご参考まで。
どちらでもテンプレートを設定できますが、テンプレートファイルの探す優先順位として、
方法① > 方法②
Githubのドキュメントに設定の詳細があります。
https://docs.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository