Open1

プルリクエスト(Pull Request)について

ひでひで

プルリクエストとは

  • 作成したコードの変更を、メインのコードに取り込んでもらうための申請
  • コードレビューを行うための仕組み
  • GitHubの重要な機能の1つ

プルリクエストの流れ

  1. 準備(ローカルPC上でのGit操作)
# 1. 新しい機能用のブランチを作成
git checkout -b feature/login

# 2. コードを変更して、コミット
git add .
git commit -m "ログイン機能を追加"

# 3. GitHubにプッシュ
git push origin feature/login
  1. プルリクエストの作成(GitHub上での操作)
  • GitHubのウェブサイトで操作します
  1. リポジトリページで「Pull requests」タブをクリック
  2. 「New pull request」ボタンをクリック
  3. 以下の項目を入力:
    • タイトル(例:「ログイン機能の追加」)
    • 説明(変更内容の詳細)
    • レビュアー(コードをレビューする人)

プルリクエストの良い例

タイトル:ログイン機能の追加

説明:
## 変更内容
- ログインフォームの作成
- パスワード認証の実装
- エラー処理の追加

## 動作確認項目
- [ ] メールアドレスとパスワードでログインできる
- [ ] 誤ったパスワードでエラーが表示される
- [ ] ログイン後にマイページに遷移する

## スクリーンショット
[画像があれば添付]

プルリクエストのメリット

  1. コードレビューができる

    • チームメンバーが変更内容を確認
    • 問題点の指摘や改善提案が可能
  2. 議論ができる

    • コメント機能でディスカッション
    • コードの品質向上
  3. 安全な開発

    • mainブランチを直接変更しない
    • レビュー後に問題なければマージ

プルリクエスト後の流れ

  1. レビュアーがコードをチェック
  2. 必要に応じて修正
  3. 承認されたらマージ(統合)
  4. ブランチの削除