はじめに
前回に続き、Git 運用についてまとめです。
今回はざっくりと開発時の Git ワークフローをまとめます。
事前準備
リポジトリのクローン
git clone https://github.com/example/example-project.git
cd example-project
課題の作成
課題(Issue)の作成
- GitHub 上で新しい Issue を作成
- Issue は出来る限り具体的に細かく作成。単位が曖昧で大きい場合は、子 Issue を作成する
- 課題番号を確認(例:#6)
ブランチ作成と開発
ブランチの作成
# レポジトリを最新化
git fetch
# 新しい機能ブランチを作成
# ベースはマージ先ブランチ origin/develop
git checkout -b feature/#6-add-new-feature origin/develop
「ブランチの命名規則と管理」については、今後記載予定
コードの実装とコミット
# コードを修正
# 変更したファイルをステージング
git add .
# 意味のあるコミットメッセージ
git commit -m "feat: #6 Add new feature implementation"
- コミットメッセージ を参照
リモートブランチへのプッシュ
# 初回のプッシュ
# 初回でリモートの追跡ブランチを設定したので、次回以降は git push だけでよい
git push -u origin feature/#6-add-new-feature
コードレビュー
Pull Request(PR)の作成
- GitHub web 画面で
feature/#6-add-new-feature
からdevelop
への PR を作成 - PR を Issue と関連付けさせる。Issue の右サイドの Development から PR を選択する。これで PR をマージすると、Issue が自動的にクローズされる
レビューフロー
「PRレビュー」については、今後記載予定
おわりに
GitHub の Issue
と PR
のワークフローは開発には必須。すごく簡単な事だけど、意外と運用してなプロジェクトもある。
「一人プロジェクトだから必要ない」と言っている方、いつか引き継ぐ時に GitHub の内容は素晴らしい引継ぎ財産になりますよー