はじめに
今回は完全に自分用の投稿になります。
GitHubのルールに沿った開発の流れを整理したかった為、ここに記述します。
※下記はGitHubDesktopを使用した流れを想定しています。
流れを確認する前に
リポジトリ
リポジトリとは、Gitの管理下にあるファイルやディレクトリの変更履歴を保管しておく箱。
ローカルリポジトリ
ローカルリポジトリとは、自分のPC上(ローカル環境)に置くリポジトリ。(PC上)
リモートリポジトリ
リモートリポジトリとは、外部サーバー上に置くリポジトリ。(GitHub上)
commit
ファイルやディレクトリの変更修正を、リポジトリに記録。
コミットメッセージ
どのような修正か分かるように記述
push
ローカルリポジトリでのコミットをリモートリポジトリに反映。
commit log
commitを確認できる。GitHub Desktopの「History」のこと。
インデックス
変更修正が、一時的に保存される場所。保存内容がcommitの対象。
add
追加するファイルや変更修正をインデックスに登録して、commitの対象にすること。GitHub上のチェックボタンのこと。
ブランチ
ファイルやディレクトリの変更の流れ。commitの連なり。
masterブランチを中心にトピックブランチに別れる。
プルリクエスト
ブランチでのコミット履歴を残し、各コミットの変更修正にコメントをつけることができるGitHubの機能。
コードレビュー
複数人開発で、コードの記述内容に問題がないか、他の開発メンバー等が確認すること。
コードレビューを担当する人をレビュアーという。
LGTM
Looks Good To Meの略コードに間違いはない。という意味。
merge
統合。ブランチをリモートリポジトリのmasterブランチに反映。
pull
リモートリポジトリの変更をローカルリポジトリに取り込む操作。
GitHubを用いた開発の流れ
ローカルリポジトリを作成してコミット
1, 「Current Repository」→「Add」→「Add Existing Repository」
2, Chooseでアプリを選択→「Add Repository」
3, 「first commit」→「commit」
リモートリポジトリを作成
1, 「Publish repository」
2, 「Keep this code private」のチェックを外す
3, 「Publish repository」
4, ブラウザでリモートリポジトリが作成できているか確認
ブランチを作成
1, 「Current Branch」→「New Branch」
2, ブランチ名入力→「Create Branch」
3, タブがmasterから切り替わっていることを確認
4, 「Publish branch」
作業
1, 作成したブランチで作業
2, 「commit」
3, 「Push origin」
プルリクエスト作成
1, 「Create Pull Request」
2, プルリクエストには、What(何を)とWhy(なぜ)を書く
コードレビュー
1, プルリクエストのURL(https:// github.com/ユーザー名/アプリ名/pull/1のような形になっているURL)を共有することで、他者にレビューを依頼
---以下レビュアー---
2, プルリクエストにコメント「Files changed」
3, コメントを残したい箇所の「+」をクリック
4, 「Start a review」
5, 「Conversation」タブ
6, コメント記入後クリック
---以下作業者---
7, コードを修正
8, 作業報告
---レビュアー---
9, LGTM
masterブランチへ反映
1, 「marge pull request」
2, 「Confirm merge」
3, 「Delete branch」
リモートリポジトリの変更をローカルリポジトリに反映
1, マスターブランチに切り替える
2, 「Fetch origin」
3, 「Pull origin」
まとめ
流れ
①ブランチを切る
②コミット
③プッシュ
④プルリク作成
⑤レビュアーが確認
⑥レビュアーが作業者に修正依頼(修正があれば)
⑦作業者が修正(⑥が行われたら行い、修正後再度プッシュ)
⑧レビュアーからのLGTM
⑨マージ
⑩プル
忘れたら確認。