【ぷるりくえすと】

プルリクエスト とは?

💡 コードを「レビュー付きで」マージする仕組み
📌 このページのポイント
プルリクエスト(レビューフロー) main feature ブランチ コミット PR マージ レビューフロー PR作成 変更を提出 コードレビュー チームが確認 修正・承認 指摘に対応 マージ mainに統合 コード品質を保ちながらチームで安全に開発を進める仕組み
プルリクエストのイメージ
ひよこ ひよこ

なんで直接マージしないの?

ペンギン先生 ペンギン先生

他の人にレビューしてもらうことで、バグの発見、設計の改善、知識の共有ができるよ。1人で書いたコードには必ず盲点がある。PRを通すことで「チームの品質基準」を満たしたコードだけがmainブランチに入る。事故防止の安全装置だね

ひよこ ひよこ

いいPRの書き方は?

ペンギン先生 ペンギン先生

①変更は小さく(300行以内が理想)、②タイトルで変更内容を簡潔に、③descriptionに「なぜ」「何を」「どうやって」を書く、④スクリーンショットや動作確認結果を添える。レビュアーの時間を尊重して「見やすいPR」を心がけよう。巨大なPRは誰もちゃんとレビューできないよ

ひよこ ひよこ

レビューで何を見るの?

ペンギン先生 ペンギン先生

①ロジックのバグや edge case、②セキュリティの問題(SQLインジェクションXSS等)、③命名やコード構造の分かりやすさ、④テストが書かれているか、⑤パフォーマンスの問題。「LGTM(Looks Good To Me)」は全て問題ないという承認。指摘はコードの行にインラインコメントで書くよ

ひよこ ひよこ

PRがマージできないときは?

ペンギン先生 ペンギン先生

CIが通らない(テスト失敗、lint エラー)か、コンフリクトが発生しているか、レビュー承認が不足しているかのどれかだよ。CIエラーはログを見て修正、コンフリクトは最新のmainをmerge/rebaseして解消、レビューは担当者にメンションで依頼。放置PRは溜まると辛くなるから早めに対応しようね

ペンギン
まとめ:ざっくりこれだけ覚えればOK!
「プルリクエスト」って出てきたら「レビュー付きでコードをマージする仕組み」と思えればだいたいOK!
📖 おまけ:英語の意味
「Pull Request」 = プル(取り込み)リクエスト(依頼)
💬 「自分の変更をメインブランチに取り込んでください」というリクエスト(依頼)だよ
← 用語集にもどる