Githubでリポジトリ用のプルリクエストテンプレートを作成する
nove-b
April 15, 2023
プルリク時の記述を共通化する
プルリク時に各々違うフォーマットで書かれるとレビューする人が大変なので、テンプレートを使用し共通化を図ることにした。 基本的にリポジトリ用のプルリクエストテンプレートの作成を参考にすれば間違いないが、ここでは最もシンプルな方法を共有する。
共通用テンプレートの作成
まずはプロジェクトのルートに移動する。
次に.githubフォルダを作成する。
でPULL_REQUEST_TEMPLATE.mdという空のファイルを作成する。
そこでにテンプレート内容を書けばok。
どんなテンプレにすればいいか
正直プルリクの運用は迷うことばかりなので、プルリクのレビューを効率的に進めるためにルールを作ってみた話を参考にした。
テンプレート内容
上記リンクから内容を拝借する。
参考:プルリクのレビューを効率的に進めるためにルールを作ってみた話
Discussion in the ATmosphere