【GitHub】トピックブランチの作成+適用方法

記事概要

GitHubでトピックブランチの作成方法及び、mainブランチへの適用方法をまとめる。

前提

• GitHubアカウントは作成済みである
• GitHub DesktopをPCにインストール済みである
• アプリケーションはGitHubに登録済みである

手順1(ブランチの作成)

1. GitHub Desktopを開く
2. 「Current Branch」をクリックする
3. 「New Branch」をクリックする
   
4. 「Name」にはブランチ名を入力する
   ※どのような作業を行うブランチなのかわかりやすいように記述すること
5. 「Create Branch」をクリックし、ブランチを作成する
6. 「main」と表示されていたタブが、先ほど設定したトピックブランチ名に変更されていることを確認する
   ※ローカルリポジトリでのブランチ作成が完了
7. 「Publish branch」をクリックする
   ※リモートリポジトリにブランチが反映される

手順2(コミット)

1. GitHub DesktopのCurrent Branchにて、トピックブランチを選択する
2. VSCodeでファイルの記述を変更する
3. 変更内容がわかるように、コミットメッセージを入力する
4. 「commit to main」をクリックする
   ※ローカルリポジトリのブランチに対して、修正内容が反映される

手順3(プッシュ)

1. 「Push origin」をクリックする
   ※リモートリポジトリへの反映を行う
   ※pushは取り消せないので、修正内容に不備がないことを確認すること
2. リモートリポジトリへ変更が反映されているか、ブラウザで確認する
   1. 「Repositories」の下にある「ユーザー名/[アプリ名]」をクリックする
   2. 「commits」をクリックする
   3. 手順2のコミットメッセージが最上部に表示されていることを確認する
   4. メッセージをクリックする
   5. 変更内容が反映されていることを確認する

手順4(プルリクエストの作成)

プルリクエストとは、ブランチでのコミット履歴を残すと共に、各コミットにおける変更修正にコメントをつけることができる機能である

1. GitHub Desktopにて、「Create Pull Request」をクリックする
2. ブラウザが起動して、プルリクエスト作成画面が表示される
3. マークダウン表記で、プルリクエストの情報を入力する

   # Message
   [必要に応じて、記載]
   
   # Why
   [なぜこの実装が必要なのかを記載]
   
   # What
   [どのような実装をしているのかを記載]
   
   # Test Evidence
   [必要に応じて、テストエビデンスを添付]
   

4. 「Create pull request」をクリックする

手順5(コードレビュー)

コードレビューとは、複数人での開発において、コードの記述内容に問題がないか、他の開発メンバー等が確認をすることである
コードレビューを担当する人をレビュアーと呼ぶ

1. プルリクエストのURLをレビュアーに共有する
2. レビュアーは、「Files changed」をクリックすると、変更修正されたコードが一覧として表示される
3. レビュアーは、修正内容を確認する
   1. 不備がある場合
      1. 特定のファイルの特定行にコメントを残す
         1. 特定のファイルのコメントを残したい行にカーソルを当てる
         2. 青色の＋ボタンが表示されるので、クリックする
         3. ＋ボタンをクリックすると、コメント用のフィールドが現れるのでコメントを記述する
         4. 「Start a review」をクリックする
      2. プルリクエスト全体に対してのコメントを残す
         1. プルリクエストの「Conversation」タブを選択する
         2. プルリクエストに対してコメントを記述する
         3. 「Comment」をクリックする
   2. 不備がない場合
      1. プルリクエスト「Conversation」タブを選択する
      2. プルリクエストに対して、「LGTM」である旨を記述する
         LGTMは「Looks Good To Me」の略であり、「コードに問題はないと思うよ！」という意味である
      3. 「Comment」をクリックする
4. レビュアーのコメントを確認する
   1. 修正する必要がある場合、手順2から実施する
   2. 修正不要の場合、手順6へ進む

手順6(マージ)

1. ブラウザにて、「Merge pull request」をクリックする
2. 「Confirm merge」をクリックする
3. 「Delete branch」ボタンをクリックする
   ※マージ済みのトピックブランチを削除する

手順7(プル)

プルとは、リモートリポジトリの変更をローカルリポジトリに取り込むことである

1. GitHub Desktopを開く
2. トピックブランチから、mainブランチに切り替える
3. 「Fetch origin」ボタンをクリックする
4. リモートリポジトリとの差分を確認する
5. 「Pull origin」をクリックする
   ※「Pull origin」ボタンが表示されない場合、Github Desktopの左側ウィンドウ「History」タブの内容が更新されていれば問題ない

補足：commit logの確認

1. GitHub Desktopを開く
2. 左側ウィンドウの「History」のタブをクリックする
3. 確認したいcommitをクリックする
   ※一番上のログが、最新である
4. commitの内容を確認する

補足：インデックスを使用したcommit

1. 修正作業を進め、複数のファイルがcommitの対象になっていることを確認する
2. ファイルのチェックを外すと、commit対象外となる
3. commitする
   ※チェックがついているファイルのみがcommitされる