Pull Request(以下 PR)の説明を書くのは面倒ですよね。。。
なので、テンプレートを活用して効率よくPRを作れるようにします
PRのテンプレートとは？
PRの説明欄に書くことのテンプレートを作成し使用することができる機能。
公式ドキュメントは↓になります。
テンプレートは以下の3か所のうちいずれかに作成すればGitHubが勝手に読み込んでくれます
（格納場所の違いはよくわかりませんでした。。。）
- ./pull_request_template.md
- ./docs/pull_request_template.md
- ./.github/pull_request_template.md
また、複数のテンプレートを使用することも可能で下記ができます
- クエリパラメータでどのテンプレートを使用するか指定できる
- 他のテンプレートを呼び出すことができる
メリット
PRのテンプレートを使用することのメリットは大きく下記があげられると思います
- PRの説明を0から書く必要がなくなる
- 内容が人によらず画一化できる
これによって、レビューする側もされる側も効率よく作業することができます
やってみる
今回は、./.github/pull_request_template.md を作成します
Markdown形式で中身を書いていきます
参考までに私が作成したテンプレートは↓です。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
## 概要 <!-- PRの背景・目的・概要 --> ## 関連タスク <!-- 関連するIssueやチケットのリンクを貼る。Issueの場合は、「#<IssueNumber>」でリンクできる --> ## やったこと <!-- このPRで何をしたのか？ --> ## やらないこと <!-- このPRでやらないことは何か？ --> ## 影響範囲 <!-- 影響を及ぼす範囲や他の機能への影響 --> ## テスト <!-- テスト方法や結果 --> ## 備考 <!-- レビュワーへの伝達事項や残しておきたい情報 --> |
余談
GitHubの全リポジトリにPRのテンプレートを使用する方法もあるみたいです
参考記事
リポジトリ用のプルリクエストテンプレートの作成 - GitHub Docs
リポジトリにプルリクエストのテンプレートを追加すると、プロジェクトのコントリビューターはプルリクエストの本体にテンプレートの内容を自動的に見ることになります。
ghdocs-prod.azurewebsites.net
Pull Requestのテンプレートを作って効率よくレビューしよう！ | DevelopersIO
GitHubではプルリクエスト時のテンプレートを作ることができます。 これによって、プルリクエストに書いてほしいことが明らかになるため、レビューする側も効率よくレビューできると思います。 そこで今回は、私が以前に作成したプルリクエストのテンプレートをご紹介します。
dev.classmethod.jp
GithubでPull Request テンプレートを使用するには？ - Qiita
はじめにGitHubは、ソフトウェア開発者がコードを管理、共有、コラボレートするための便利なプラットフォームです。Pull Request（PR）は、GitHubで最も重要なコラボレーション機能の…
qiita.com
コメント