こんにちは、Tech Samuraiです!
これまでの記事で、Ryeを使ったモダンなPython環境の構築方法と、Gitの基本的なコマンドや履歴管理の方法を探検してきました。準備は整いました。では、これらを組み合わせて、日々の開発は具体的にどのように進めていけば良いのでしょうか?
今回の記事は、その疑問に答えるための、超実践的なワークフローガイドです。あなたが新しい機能を追加するタスクを任されたと仮定して、作業を開始してから、その成果をGitHubに反映させるまでの一連の流れを、具体的なコマンドと共にステップバイステップでシミュレーションします。
このページをブックマークしておけば、いつでもプロフェッショナルな開発の流れを確認できる、あなたの頼れる相棒になるはずです!
前提条件
この記事では、以下の準備が完了していることを前提とします。
- RyeとGitの初期設定が完了している。
- Ryeで作成したプロジェクトが、GitHubのリモートリポジトリと連携済みである。
日々の開発ワークフロー:一つの機能を実装する流れ
ここからは、「ユーザープロフィール機能を追加する」というタスクを例に、具体的なコマンドを見ていきましょう。
ステップ1:最新の状態に同期する
【目的】作業を始める前に、必ずリモートリポジトリ(GitHub)の最新の変更内容を自分のPCにダウンロードします。これを怠ると、後で他の人の変更と衝突(コンフリクト)する原因になります。
# 1. まず、本流であるmainブランチに移動する
git switch main
# 2. リモートのmainブランチの最新内容をローカルに持ってくる
git pull origin main
ステップ2:作業用のブランチを作成する
【目的】main`
ブランチを直接汚さずに、安全な「作業スペース」を確保します。ブランチ名は、何のための作業か分かるように付けるのがルールです。
# "feature/user-profile" という名前で新しいブランチを作成し、そこに移動する
git switch -c feature/user-profile
(ヒント:新しい機能ならfeature/
、バグ修正ならfix/
といった接頭辞を付けると、ブランチの目的が分かりやすくなります)
ステップ3:コーディングとコミット
【目的】作成したブランチの中で、自由にコーディングを進めます。Ryeで新しいライブラリを追加したり、既存のファイルを編集したりします。作業のキリが良いところで、セーブポイント(コミット)を作成します。
# (ここでファイルを編集したり、`rye add ライブラリ名` を実行したりする)
# 1. 変更内容を確認する(癖にすると良い)
git status
# 2. 全ての変更をステージングエリアに追加する
git add .
# 3. 変更内容を分かりやすいメッセージと共にコミットする
git commit -m "feat: ユーザープロフィールの基本レイアウトを追加"
(ヒント:コミットメッセージの先頭にfeat:
(機能追加)やfix:
(修正)といった種類を書く「Conventional Commits」という規約は、履歴を綺麗に保つための良い習慣です)
ステップ4:リモートリポジトリにプッシュする
【目的】ローカルPCに保存したコミットを、GitHubのリモートリポジトリにアップロードします。これにより、初めて他の人があなたのコードを見れるようになります。
# feature/user-profile ブランチを、リモート(origin)にプッシュする
git push -u origin feature/user-profile
(ヒント:初回だけ-u`
を付けると、次回以降はこのブランチからgit push
と打つだけで同じ場所にプッシュできるようになります)
ステップ5:プルリクエストを作成する
【目的】「私の作業が完了したので、本流の`main`ブランチに取り込んでもらえませんか?」という、レビュー依頼を作成します。このステップは**GitHubのWebサイト上**で行います。
- GitHubのリポジトリページに行くと、「`feature/user-profile` had recent pushes」という通知と共に、「Compare & pull request」ボタンが表示されているはずです。これをクリックします。
- 変更内容のタイトルと説明を書き、「Create pull request」ボタンを押します。
これで、チームメンバーがあなたのコードをレビューし、問題がなければ`main`ブランチにマージ(統合)する準備が整いました。
ステップ6:マージと後片付け
【目的】プルリクエストが承認され、`main`ブランチにマージされた後、不要になった作業ブランチを整理して、次の作業に備えます。
# 1. mainブランチに戻る
git switch main
# 2. マージされた最新のmainブランチの内容をローカルに持ってくる
git pull origin main
# 3. 不要になったローカルの作業ブランチを削除
git branch -d feature/user-profile
# 4. (任意) GitHub上の作業ブランチも削除
git push origin --delete feature/user-profile
まとめ
日々の開発における一連の流れは、「pull
→ switch -c
→ (作業 & commit
) → push
→ プルリクエスト → マージ → 後片付け」というサイクルになります。このワークフローを守ることで、一人での開発でも安全に履歴を管理でき、チーム開発にもスムーズに参加することができます。
ぜひ、この流れをあなたの手元で何度も繰り返し、身体に覚えさせてみてください!
【Rye & Git 実践ワークフロー】ブランチ作成からプルリクエストまで、日々の開発の流れを完全解説
【Git備忘録】コミット履歴を自由自在に操る!log, reset, revert, rebaseを徹底解説
コメント