GitBucketでプルリクエストテンプレートを設定する方法

動機

仕事でGitBucketをチームで運用しプロジェクト管理しているのですが、プルリクの概要メッセージルールがメンバーに浸透せず整いませんでした。(ルールドキュメントが別の場所にあるため)
そこでテンプレートを導入し、ある程度整えられないか検討しました。

簡単な検証環境(GitBucket準備)

自宅で検証するため、簡単に確認できるGitBucket環境を作りました。
前提条件として、dockerがインストール済とします。

docker run -d -p 8080:8080 gitbucket/gitbucket

• http://localhost:8080
• アカウントはroot/root

• 簡単に環境ができました。ポチポチとリポジトリを作っていきましょう。
  
  

プルリクエストのテンプレート作成

ファイル名をpull_request_template.mdとし、ルートディレクトリに配置します。
この名前と配置場所がポイントです。
今回はテンプレートサンプルとしてCovid-19Radar/Covid19Radar/を参考にしてみました。

• GUIからサクッとmasterに追加してしまいます。

プルリクエストを作成しテンプレートを確認。

なにか適当なブランチをpushしプルリクエストを作成してみます。

• 無事テンプレートが生成されていました！プレビューで見てみるといい感じですね。

• 検証から、プルリクエストテンプレートの導入はとてもハードルが低いことがわかりました。
• 品質向上にじわじわと効果がでると思いますので是非お試しくださいませ。

参考資料