GitHub運用の基本:リポジトリ作成から安全なブランチ運用まで
はじめに
本記事では、GitHubでの開発を
1. リポジトリ作成とローカル連携、
2. ブランチを使った開発の流れ、
3. マージ後にローカルへ反映する慎重な手順
の3段階に分けて解説します。
これは私の備忘録として作成したものですので、間違い・より良いプロジェクトの管理方法等があればご指摘いただけますと幸いです。
1. リポジトリの作成とローカルプロジェクトのGitHub連携
① GitHub上でリポジトリを作成
- GitHubにログインし、「New Repository」をクリック
- 名前を入力(例:
ExamApp) - Private または Public を選択
- 「Create Repository」を押す
② ローカルでプロジェクトをGitHubと連携
すでにローカルにあるフォルダを連携する場合:
cd ~/dev/project-name # 作業フォルダへ移動
git init # Gitの初期化
git remote add origin https://github.com/username/repo-name.git
git add .
git commit -m "Initial commit"
git push -u origin main # リモートへ初回プッシュ
2. ブランチを使った開発手順と命名規則
① 新しいブランチを作る
作業単位ごとにブランチを作成します:
git checkout -b refactor/top
feature/:新機能追加
fix/:バグ修正
refactor/:リファクタリング(構造改善)
hotfix/:緊急修正
例:feature/add-logging, refactor/data-loader
② 作業・コミット・プッシュ
開発後、変更を反映します。
git status # 変更確認
git add . # 全てステージング
git commit -m "○○の改善"
git push -u origin refactor/top # 初回プッシュ
# または
git push # 2回目以降であれば省略可能
この例では上記の流れですが、プロジェクトによって先に .gitignore を作成して不要なファイルを除いたり、add <ディレクトリ名> のようにして特定のディレクトリのみ連携したりなど、自分にあった方法を取ってください。
③ Pull Requestを作成してmainへマージ
GitHub上で「Compare & pull request」をクリック
内容を確認してPRを作成
レビュー後、main にマージ
マージ完了後、不要なブランチは削除(自動削除でもOK)
3. mainへのマージ後、ローカルに反映する慎重な手順
マージ後にローカルを最新化する際は、
いきなり pull せずに差分を確認してから が安全です。
# 手順
git checkout main # mainに切り替え
git fetch origin # リモートの更新を取得(まだ反映しない)
git diff main origin/main # 差分確認(内容を詳しく見る)
git log --oneline main..origin/main # どんなコミットが増えたかを確認
git diff --stat main origin/main # または変更ファイル一覧だけ見る場合(個人的にはこちらで十分)
git pull origin main # 問題なければローカルを更新
# 状況確認
git status
が以下のようになっていればOK:
ブランチ main
Your branch is up to date with 'origin/main'.nothing to commit, working tree clean
まとめ
-
mainブランチは常に「安定版」として保ち、
-
開発作業は常にブランチを切って進め、
-
マージ後はローカルを安全な手順で最新化する。
まだまだたくさんの工夫があるとは思いますが、個人であればとりあえずこれを抑えておけばよいのではないかと思います。
また発見があれば更新していきます!!
便利なコマンド
# 「ローカルにだけ存在するコミット」を表示
git log origin/main..main --oneline
# ローカルのmainを完全にリモートと同じ状態に戻す
git reset --hard origin/main