【Git＋GitHub】チーム開発のための環境構築〜プルリクエスト作成まで

はじめに

こんにちは。
こちらの記事では、チーム開発でGitとGitHubの扱う方法を記しています。
誤っている点やアドバイスがございましたらコメントいただけると幸いです。

実装手順

• プロジェクトのリモートリポジトリを clone する
• 環境構築する
• リモートにあるブランチから作業ブランチを作成する
• リモートリポジトリに push してプルリクエストを作成する
• レビューを受ける

1. プロジェクトのリモートリポジトリを clone する

プロジェクトのリポジトリに参加して、そこからクローンを行う。
チーム開発だと、 https ではなく ssh からクローンすると思うので、

• 個人アクセストークンの発行
• SSHキーの追加
• SSOの有効化

などを事前に行なっておく。
※ https だと、大容量ファイルなどを正常にダウンロードできないななど、不具合が起こる可能性があるようです。

参考リンク：

• https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
• https://docs.github.com/ja/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account
• https://docs.github.com/ja/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on

公開鍵の設定ができたら、ターミナルで git clone します。

$ git clone [e-mail]:~hogehoge~

2. 環境構築する

プロジェクトのリポジトリにあるREADMEやチームの方針に従って、言語や開発に使用するツールなどのインストール、データベースやDockerなどの環境構築をして、ローカル画面の表示確認（localhost:0000）まで行なってください。
（ここはチームによってそれぞれだと思うので割愛します）

3. リモートにあるブランチから作業ブランチを作成する

クローンした環境でブランチの確認を行います。

$ git branch
* main
develop

main や develop ではなく、リモートにあるブランチを親ブランチに指定して作業ブランチを作成したい場合は、下記コマンドを実行する。
（親ブランチを sample、作業ブランチを future/sampleと仮定する）

// 最新のブランチ情報を取得する
$ git fetch -p

// リモートにあるすべてのブランチを一覧表示して、親ブランチを確認する
$ git branch -a                                    

// リモートブランチを親にして、ローカルに作業ブランチをcheckoutする
$ git checkout -b feature/sample origin/sample

参考リンク：

• https://noumenon-th.net/programming/2018/12/24/git-fetch/
• https://qiita.com/YusukeSuzuki@github/items/3bd5752783fd2c2f8805

ブランチが作成できているか確認ができたら、そのブランチで作業を行う。

$ git branch
main
develop
* feature/sample

4. リモートリポジトリに push してプルリクエストを作成する

変更箇所をリモートリポジトリに push していく。
チームの方針によって様々だと思うが、コミットメッセージにプレフィックスをつけると、何が変更されたのかわかりやすい

参考リンク：https://qiita.com/numanomanu/items/45dd285b286a1f7280ed

// ファイルの変更箇所を確認する
$ git status

// ファイルを指定する場合は、add の後ろに変更ファイルのディレクトリを記述する
$ git add .

// コミットメッセージも記述しておく
$ git commit -m "コミットメッセージ"        

// リモートリポジトリに push する
$ git push origin feature/sample

GitHubのリモートリポジトリにあるPull requestsから、New pull resuestを押下して作成する。その際、どのブランチからどのブランチにマージを行うのか必ず指定する。

base:    sample
compare: future/sample

5. レビューを受ける

レビュアーを指定してレビューを受けてから、OKが出ればマージしていただく。

参考リンク：https://www.udemy.com/course/unscared_git/

おわりに

ここまでチーム開発でGitとGitHubの扱う方法についてまとめました。
以上、最後まで読んでいただきありがとうございました！
よければLGTMを押してくれると嬉しいです！