🔥

【GitHub】Pull Request のテンプレートを使ってレビューを効率的に行う

に公開
GitHub
tech

Pull Request(以下 PR)の説明を書くのは面倒ですよね。。。

なので、テンプレートを活用して効率よく PR を作れるようにします

PR のテンプレートとは？

PR の説明欄に書くことのテンプレートを作成し使用することができる機能。

公式ドキュメントは ↓ になります。

https://docs.github.com/ja/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

テンプレートは以下の3 か所のうちいずれかに作成すれば GitHub が勝手に読み込んでくれます

（格納場所の違いはよくわかりませんでした。。。）

  1. ./pull_request_template.md
  2. ./docs/pull_request_template.md
  3. ./.github/pull_request_template.md

また、複数のテンプレートを使用することも可能で下記ができます

  • クエリパラメータでどのテンプレートを使用するか指定できる
  • 他のテンプレートを呼び出すことができる

メリット

PR のテンプレートを使用することのメリットは大きく下記があげられると思います

  1. PR の説明を 0 から書く必要がなくなる
  2. 内容が人によらず画一化できる

これによって、レビューする側もされる側も効率よく作業することができます

やってみる

今回は、./.github/pull_request_template.md  を作成します

Markdown 形式で中身を書いていきます

参考までに私が作成したテンプレートは ↓ です。

## 概要
<!-- PRの背景・目的・概要 -->


## 関連タスク
<!-- 関連するIssueやチケットのリンクを貼る。Issueの場合は、「#<IssueNumber>」でリンクできる -->


## やったこと
<!-- このPRで何をしたのか？ -->


## やらないこと
<!-- このPRでやらないことは何か？ -->


## 影響範囲
<!-- 影響を及ぼす範囲や他の機能への影響 -->


## テスト
<!-- テスト方法や結果 -->


## 備考
<!-- レビュワーへの伝達事項や残しておきたい情報 -->

余談

GitHub の全リポジトリに PR のテンプレートを使用する方法もあるみたいです

https://zenn.dev/mm67/articles/1021f0f978fade

参考記事

https://docs.github.com/ja/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

https://dev.classmethod.jp/articles/pull-request-template/

https://qiita.com/atsutama/items/03753925762fd094ec9c

Discussion