開発が捗るPull Requestの作り方の心がけについてまとめてみました

1. はじめての
Pull Request
株式会社エクストーン 豊田陽一

2. 今日のお話
▰ Pull Request時に気を付けることにつ
いて話します！
▰ コミットの単位
▰ コミットコメント
▰ Pull Requestに書くこと
▰ レビュー依頼前に

3. Pull Request
▰ GitHubの主たる機能
▰ ブランチのマージを依頼
▰ クローンしたプロジェクトから本家への反映依頼を出す
用途で使われるので 、Pull Requestと呼ばれる
▰ GitLabではMerge Requestという名前で同等の機能
が提供されている

4. Pull Request (2)
▰ 目的
▰ 自分の開発したコードをプロジェクトに反映させ
るための手段
▰ コードレビューを行うことで、必ずプロジェクトに反映さ
れる前に人の目が入る
▰ 機能単位でPull Requestを作ることによって、機能と
コードの差分が明確になる

5. コードレビュー
▰ 他人のコードの問題点を指摘する
▰ よりよい設計がある
▰ 考慮すべき点が抜けている
▰ etc.
▰ 必ずしも不具合がないことを担保するものでは
ない
▰ LGTM! (Looks good to me!)

6. コードレビュー (2)
▰ 問題点
▰ レビュアーの時間がかかる
▰ 力関係がレビュアー＜レビュイーの場合
▰ 自分よりできる人のコードについて正しく指摘できる自
信がない…

7. レビュイーが心がけること

8. Pull Requestの単位
▰ 複数の課題を解決しない
▰ 〇〇の機能を追加して、ついでに依存ライブラリ
のバージョンを上げた等
▰ 依存ライブラリのバージョン更新だけ別の Pull
Requestを作るべき
▰ レビュアーは「そのコードが何のために追加され
たのか」を知らない

9. Commitの単位
▰ コミットコメントで説明できる単位でコミッ
トを分割する
▰ Commitが大きいとコンフリクト時の対応が大変
になる
▰ レビュアーがコミット単位でコードの差分を読め
るようになる

10. Commitの単位 (2)
▰ Conventional Commitの活用
▰ コミットコメントの前に接頭語をつける
▰ fix: 不具合の修正
▰ feat: 機能の追加
▰ BREAKING CHANGE: 非互換性をもたらすような重大
な変更
▰ 接頭語に悩む場合、適切な単位でCommitが作
られていない可能性が高い

11. Commitの単位 (3)
▰ 後から修正できるので開発中は気軽に
Commitしてもよい
▰ git rebase -i
▰ 個々のコミットをインタラクティブに修正・結合等が行え
る

12. Pull Request本文
▰ What（何を）とHow（どのように）を明確
に仕様
▰ Whatに関しては関連Issueと紐づける
▰ #123とか書けば勝手にリンクされる
▰ この問題に対してどのように対処したかを説明
する
▰ 複数の選択肢から実現方法を選んだ場合は、その理
由等も書く
▰ 説明できないコードを書いてはいけない

13. Pull Request本文 (2)
▰ WIP (Work in Progress)の活用
▰ 作業中のブランチでもPull Request作ってかま
わない
▰ 自分のコードに対して意見を募る
▰ Pull Requestが作られないと、他の人のコードが読み
づらい

14. レビュー依頼前に
▰ レビュアーはデバッガではない
▰ 動くコードをレビューに上げよう
▰ テストが一通りパスしている
▰ 動作確認を行っている
▰ 行った動作確認の方法も Pull Requestに記述す
るといい
▰

15. レビュー依頼前に (2)
▰ レビュアーは静的解析ツールではない
▰ コーディング規約に従ったコードを作ろう
▰ インデント幅が違う、変数名が大文字で始まっている、
改行がない、等の規約をレビュアーに突っ込ませない
▰ 静的解析ツールを使おう
▰ jslint, rubocop, etc.

16. レビュアーが心がけること

17. 時間をあまり使わない
▰ コードとにらめっこしても分からないこと
は素直に書いた人に話を聞く
▰ それが出来ない環境の人が相手の場合、修正
依頼でPull Requestの説明を求める

18. 些細なことに突っ込まない
▰ 突っ込みをしなければいけないわけで
はない
▰ 本質的なことからレビューするように心がけよう
▰ コーディング規約等の問題なら、環境から整備
しよう
▰ どうでもいい突っ込みを入れて仕事した気にな
らない

19. 人間性重要
▰ 必要以上に強い言葉を使わない
▰ レビュイーを委縮させない
▰ 相手の能力・選択を尊重する
▰ 修正をしてもらいたい場合は、ちゃんとレビュ
イーに納得してもらうこと

20. レビュアーが質問してもいい
▰ 分からないことは素直に聞こう
▰ 内容の共有が出来るだけでも価値がある
▰ 「直さなきゃいけない」というプレッシャーに悩ま
される必要はない

21. まとめ
▰ Pull Requestの心がけ
▰ Pull Requestの単位に気を付ける
▰ Commitの単位に気を付ける
▰ ちゃんと説明する
▰ レビュアーは必要以上に時間を使わない
▰ 人間性大事