今回やること
この記事では、GitHubでPull Requestを作る前に、レビューしやすい状態に整える流れを確認します。
Pull Requestは、コードを見てもらうための提出物です。作る前に自分で差分を確認します。
前提条件
- GitHubリポジトリがある
- featureブランチで作業している
- 変更をcommit済み
- pushできる状態
Step 1: ブランチを確認する
git branch
作業ブランチにいることを確認します。
git status
未コミット変更が残っていないか見ます。
Step 2: mainとの差分を見る
git diff main...HEAD
GitHubのPR画面で表示される差分に近い形で、変更内容を確認できます。
Step 3: コミット履歴を見る
git log --oneline main..HEAD
PRに入るcommitが想定通りか確認します。
Step 4: テストやビルドを実行する
プロジェクトに合わせて確認します。
npm test
npm run build
コマンドはプロジェクトごとに違います。READMEや設定ファイルを確認します。
Step 5: pushする
git push -u origin feature/example
すでに上流ブランチが設定されていれば、次で十分です。
git push
Step 6: GitHubでPRを作る
GitHubの画面からPull Requestを作ります。
PR説明には、次を入れるとレビューしやすくなります。
## 変更内容
-
## 確認したこと
- [ ] テストを実行した
- [ ] ビルドを実行した
- [ ] 画面を確認した
## 補足
-
PR本文には、変更内容だけでなく、確認したことも書きます。
Step 7: 自分でPR差分を読む
作成後、Files changedを開いて自分で差分を見ます。
見る観点は次の通りです。
| 観点 | 確認すること |
|---|---|
| 余計な変更 | 関係ない整形やファイルがないか |
| 秘密情報 | APIキーや個人情報がないか |
| テスト | 変更に対する確認があるか |
| 説明 | レビュー者が背景を理解できるか |
よくあるエラー
| 状況 | よくある原因 | 確認すること |
|---|---|---|
| PRに関係ない変更が入った | ブランチを分けていない | git diff main...HEAD を見る |
| テスト結果が不明 | 実行していない | PR本文に確認結果を書く |
| pushできない | リモート設定や認証の問題 | git remote -v を確認 |
| レビューが進まない | 説明不足 | 目的と確認方法を書く |
まとめ
Pull Requestを作る前に、ブランチ、差分、commit、テスト、ビルドを確認します。PR本文には、変更内容と確認したことを書きます。作成後もFiles changedを自分で読み、レビュー者に渡せる状態か確認します。
参考リソース
← 一覧に戻るPR
PR