レビューしやすいプルリクを作ろう

レビューしやすいプルリク  を作ろう    2022.10.12  コードレビュー LT会 - vol.3    Fujisawa
Chihiro 

自己紹介  • Fujisawa Chihiro  • Webアプリ、スマホアアプリ  • ゲーム大好き、ポケモン楽しみ  • 絶賛就職活動中 
Twitter @chihiro0940  

今日のテーマ  レビューしやすいプルリクを作ろう 

レビューしやすいプルリクとは？  • レビューできるだけの情報が揃っている(情報にアクセスできる)  • 見やすい  • 正確・・・などなど 

今日話すこと  • どうやって？  ◦ GitHubのプルリクエストテンプレート  • どんな情報を？  ◦ テンプレートの中身 

注意  • 今日はGitHubを題材に話します  • Qiitaにも似た内容の記事を書いています  ◦ 「テンプレートを使って、より良い情報が入った&レビューしやすいプルリクを」   ◦ 「【Git】commitの粒度」 

プルリクエスト  テンプレート 

プルリクエストテンプレートとは  プルリクエストテンプレートを設置することで、プルリクエスト作成時に本文部分にテンプレートの内容を反映することができる。 

テンプレートなし 

テンプレートあり 

テンプレートの作成方法  テンプレートを設定したいリポジトリに pull_request_template.md という名前でテンプレートを作成する。  ファイルの置き場は以下のうちのどこか。  • リポジトリルート/pull_request_template.md  • リポジトリルート/docs/pull_request_template.md 
• リポジトリルート/.github/pull_request_template.md    参考: https://docs.github.com/ja/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-reque st-template-for-your-repository  

テンプレートの作成方法  https://github.com/chihirof/github-template-sample 

テンプレートの内容 

内容一覧(案)  1. タスク概要  2. このプルリクエストがマージされると何が変わるか？  3. やらないこと  4. レビューしてほしい観点  5.
確認したこと  6. プルリクエスト作成時のチェックリスト  7. レビューしてくれる方へ 

1.タスク概要  • このプルリクエストの元ネタであるタスクの概要(背景)をレビュアーに説明する  • Issueや外部サービスで、タスク、チケット、課題等を管理していれば、そのリンクを貼るのでもOK     

2.このプルリクエストがマージされるとどうなるか？  • プルリクエストがプロダクトに与える影響をレビュアーに説明する  • どんな変更を加えたのか、その結果どうなるのか、など  ◦ 画面変更の場合はここにbefore/afterのスクショを貼るなどもOK 

3.やらないこと  • このプルリクエストでは対応しないことをレビュアーに説明する  ◦ UIへの表示は次のプルリクエストで対応します、など 

4.レビューしてほしい観点  • レビュアーに特段レビューして欲しい点があれば説明する  ◦ この変数名、もっといいものがないかな？  ◦ ここの設計、迷ったけどどうでしょう？など 

5.確認したこと  • 動作確認した内容をレビュアーに説明する 

6.プルリクエスト作成時のチェックリスト  • レビューに出す前に確認すべきことのチェックリスト  ◦ チェックボックスにチェックをする  • 毎回やらなくてもいいけども、場合によっては必要なことなど  ◦ 特定の変更がある場合にテストすること 
◦ このファイルに変更があったらこっちも確かめること、など 

7.レビューしてくれる方へ  • レビュアーに忘れないでほしいこと  • (例えば)コメントには優先度をつけましょう  ◦ MUST/IMO/IMHO/nits  ◦ https://qiita.com/kuniyonkunisan/items/2ed8c48ff349e6add45b 

まとめ 

プルリクエストを充実させるメリット  • レビューを効率よく進められる  ◦ タスク自体に関するやりとりが減る  ◦ 適切なコメントをもらえる  ▪ 「この処理が必要ではないですか？」「そこは次のプルリクでやります」 
• プルリクエストを書く中で気づくことがある  ◦ 動作確認欄に書きながら「あ、このケース見ていないな・・・」  ◦ 実装中モードから頭を切り替えられる 

最後に  • テンプレートは定期的に見直しを  ◦ チェックリストの中身は常に最新化する  • チームで話して試行錯誤していくことが大事  ◦ レビューに何を求める？  •
充実したレビューのためにできることは他にもある  ◦ 適切な粒度のコミットに分ける、など 

その他参考リンク  • https://github.blog/2015-01-21-how-to-write-the-perfe ct-pull-request/  • https://github.com/thoughtbot/guides/tree/main/code- review 

ご清聴ありがとうございました！ 

レビューしやすいプルリクを作ろう

レビューしやすいプルリクを作ろう

chihiro

More Decks by chihiro

Other Decks in Technology

Featured

Transcript