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

2022年10月12日に行われた「コードレビュー LT会 - vol.3」の発表資料です。

Transcript

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

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

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

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

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

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

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

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

9. テンプレートなし

10. テンプレートあり

11. テンプレートの作成方法
 テンプレートを設定したいリポジトリに 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 

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

13. テンプレートの内容

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

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

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

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

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

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

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

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

22. まとめ

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

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

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

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