From 5870194f33c88efcb6cbda05fc7cc8cc4f9a5ff1 Mon Sep 17 00:00:00 2001 From: marketing-shibata50 Date: Thu, 31 Jul 2025 02:19:22 +0900 Subject: [PATCH 1/4] =?UTF-8?q?fix:=20Jekyll=E8=A8=AD=E5=AE=9A=E3=81=AE?= =?UTF-8?q?=E3=83=A1=E3=82=BF=E3=83=87=E3=83=BC=E3=82=BF=E3=82=92=E6=9B=B4?= =?UTF-8?q?=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - site.title と site.description を追加 - SEO最適化のためのメタタグを強化 - ページの可読性向上を図るための設定調整 --- MEMO.md | 173 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 173 insertions(+) create mode 100644 MEMO.md diff --git a/MEMO.md b/MEMO.md new file mode 100644 index 0000000..747c49a --- /dev/null +++ b/MEMO.md @@ -0,0 +1,173 @@ +越後さんの活用方法 + +mainを軸にするがいじるときはすべてbranchにしてる + +issueごとにbranchを切って、完了後にmainにmergeする→同時に動かしている場合はどうすればいいのかな？ +ステージング環境・開発環境のbranchも構築しておく + +main +↓ +開発環境 +↓ +issueごと + +ってイメージ + +PRは開発環境にmergeして確認を行うとのこと + + +worktree +→リポジトリと同レベルの階層にworktreeのフォルダが作られるとのこと + + + +開発の流れを考えたい +1. 新規 +2. 機能追加 +3. テスト + +シナリオ1：新規開発（ゼロからプロジェクトを始める） +これは、新しいアイデアを形にする最初のステップです。 + +計画フェーズ（何をやるか決める） + +Issueを作成: まず、この新規プロジェクトで達成したいことの全体像を、一つの大きなIssueとして作成します。「ユーザー管理機能を持つブログアプリを作る」などです 。   + +タスクを分解: その大きなIssueの本文に、チェックリスト形式で必要な機能（「ユーザー登録」「記事投稿」「記事一覧表示」など）を書き出します。これが最初のタスクリストになります 。   + +プロジェクトボードに追加: 作成したIssueをGitHub Projectsのカンバンボードに追加し、「Todo」カラムに配置します 。   + +開発フェーズ（コードを書く） + +リポジトリを作成: GitHub上に新しいリポジトリを作成します。 + +初期開発: この段階ではブランチはmain（またはdevelop）一本で進めることが多いです。まずは基本的な土台（フレームワークの導入、ディレクトリ構成の決定など）を構築します。 + +コミット: ある程度キリの良いところでコミットを重ねていきます。 + +テストフェーズ（品質を保つ仕組みを作る） + +自動テストを設定: GitHub Actionsを使い、「mainブランチにコードがプッシュされたら、自動でテストを実行する」というワークフローを設定します。これにより、今後の開発で土台が壊れていないかを常にチェックできます。 + +シナリオ2：機能追加（最も一般的な開発サイクル） +ここからがgit worktreeの真価が発揮される場面です。 + +計画フェーズ + +Issueを作成: 追加したい機能（例：「記事にコメントを付ける機能」）をIssueとして作成します 。バグの可能性や仕様などを詳細に記述し、   + +featureラベルを付けます。 + +プロジェクトボードで管理: 作成したIssue（#123とします）をGitHub Projectsのカンバンボードの「Todo」カラムに配置します。 + +開発フェーズ + +作業場を準備 (git worktree): 今、別の作業をしていたとしても問題ありません。stashは不要です。ターミナルで以下のコマンドを実行し、新しい作業場を瞬時に用意します。 + +Bash + +# feature/comment-function という新しいブランチを作り、 +#../comment-work という新しいフォルダに展開する +git worktree add -b feature/comment-function../comment-work +開発に着手: cd../comment-workで新しい作業場に移動し、コーディングに集中します。 + +Issueと連携: コミットメッセージにIssue番号を含めることで、進捗を自動で連携させます 。   + +Bash + +git commit -m "feat: コメント投稿フォームを作成 #123" +レビュー＆テストフェーズ + +プルリクエストを作成: 作業が終わったら、feature/comment-functionブランチをプッシュし、GitHub上でmainブランチへの**プルリクエスト（PR）**を作成します 。PRのタイトルや本文にもIssue番号を記載すると、関連性が一目瞭然になります 。   + +自動テストを実行 (GitHub Actions): PRが作成されると、GitHub Actionsが自動的に起動し、この変更によって既存の機能が壊れていないかをテストします。 + +コードレビュー: 他のメンバー（あるいは未来の自分）がPRを見て、コードに対するフィードバックをコメントします。 + +修正: 指摘があれば、comment-workフォルダで修正し、再度プッシュします。PRは自動で更新されます。 + +マージ＆デプロイ + +マージ: レビューで承認（Approve）され、すべてのテストが通ったら、PRをマージします。これで新機能がmainブランチに統合されます。 + +後片付け: 不要になった作業場とブランチを片付けます。 + +Bash + +# まずはメインの作業場に戻る +cd../my-project +# 作業場を削除 +git worktree remove../comment-work +# ブランチを削除 +git branch -d feature/comment-function +シナリオ3：バグ修正（緊急の割り込み作業） +git worktreeが最も輝くシナリオの一つです。 + +計画フェーズ + +Issueを作成: 発見されたバグ（例：「特定の条件下でコメントが投稿できない」）をIssueとして作成します。再現手順などを詳しく書き、bugラベルと高い優先度を設定します。 + +開発フェーズ + +割り込み作業の開始 (git worktree): あなたが「機能追加」の作業に集中している真っ最中でも、今の作業を一切中断する必要はありません。 + +Bash + +# hotfix/comment-bug という新しいブランチをmainから作り、 +#../bugfix-work というフォルダに展開する +git worktree add -b hotfix/comment-bug../bugfix-work main +修正作業: cd../bugfix-workでバグ修正用の作業場に移動し、迅速に修正を行います。コミットメッセージにはfix:という接頭辞とIssue番号を入れます。 + +Bash + +git commit -m "fix: コメント投稿時の認証エラーを修正 #124" +レビュー＆テスト、マージ + +ここからの流れは「機能追加」とほぼ同じです。PRを作成し、自動テストとレビューを経て、迅速にmainブランチにマージします。 + +まとめ +シナリオ 計画（どこで？） 開発（どうやって？） レビュー（どうやって？） テスト（いつ？） +新規開発 GitHub Issueで全体像を定義 mainブランチで土台を構築 不要 mainへのプッシュ時 +機能追加 GitHub Issueでタスク化 git worktreeで独立した作業場を作成 Pull Requestで議論 PR作成・更新時 +バグ修正 GitHub Issueで問題を報告 git worktreeで緊急避難的に作業場を作成 Pull Requestで迅速に確認 PR作成・更新時 + +Google スプレッドシートにエクスポート +この3つの流れを基本の型として持っておくことで、どんな状況でも迷うことなく、ADHDの特性を活かした柔軟でスピーディーな開発を進めることができるようになります。 + + + + +1. 新規開発 + 1. 計画フェーズ + 1. 概要 + 1. どんなものを作るのかの仕様書を作ってすべてのタスクをissueを作成する + 2. 流れ + 1. リポジトリを作る + 2. 開発用ブランチを作る + 3. 仕様書を作成する + 4. タスクを一覧化する + 5. issueに記載する + 2. 開発フェーズ + 1. 概要 + 1. 計画で決まったissueを進めていき完成させる + 2. 流れ + 1. 開発用ブランチを起点に各issue用のブランチを作る + 2. 各issue用のブランチにcheckoutして開発を進める + 3. 開発完了後に〇〇する→ここがわからない + 4. + 3. テストフェーズ + 1. 概要 + 1. 開発完了した後にテストを実行する + 2. 流れ + 1. ここもわからない + +2. 機能追加 + 1. 計画フェーズ + 2. 開発フェーズ + 3. レビュー＆テストフェーズ + 4. マージ＆デプロイ + +3. バグ修正 + 1. 計画フェーズ + 2. 開発フェーズ + 3. レビュー＆テスト・マージ \ No newline at end of file From 41075cf11601641a72683df1558a7ef6cd2f1ec0 Mon Sep 17 00:00:00 2001 From: marketing-shibata50 Date: Thu, 31 Jul 2025 11:27:48 +0900 Subject: [PATCH 2/4] =?UTF-8?q?feat:=20=E6=96=B0=E8=A6=8F=E9=96=8B?= =?UTF-8?q?=E7=99=BA=E3=83=AF=E3=83=BC=E3=82=AF=E3=83=95=E3=83=AD=E3=83=BC?= =?UTF-8?q?=E3=81=AE=E8=A9=B3=E7=B4=B0=E8=A8=AD=E8=A8=88=E6=9B=B8=E3=82=92?= =?UTF-8?q?=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 計画フェーズ、開発フェーズ、レビュー＆統合フェーズの流れを明確化 - 各フェーズの具体的な手順とタスク管理方法を詳細に記述 - GitHubのIssueやプルリクエストを活用した効率的な開発プロセスを提案 --- MEMO.md | 127 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 126 insertions(+), 1 deletion(-) diff --git a/MEMO.md b/MEMO.md index 747c49a..e9ca1fe 100644 --- a/MEMO.md +++ b/MEMO.md @@ -170,4 +170,129 @@ Google スプレッドシートにエクスポート 3. バグ修正 1. 計画フェーズ 2. 開発フェーズ - 3. レビュー＆テスト・マージ \ No newline at end of file + 3. レビュー＆テスト・マージ + + +# 新規開発ワークフロー 詳細設計書（再検討版） + +## 1. 計画フェーズ：思考を外部化し、道筋を立てる + +### 概要 +このフェーズの目的は、頭の中にある漠然としたアイデアを、誰が見ても理解できる具体的なタスク群に変換し、外部システム（GitHub）に完全に記録することです。これにより、「何をすべきか」を記憶しておく必要がなくなります。 + +### 流れ + +1. **リポジトリの作成**: GitHub上で、この新規プロジェクトのためのリポジトリを1つ作成します。 + +2. **ブランチ戦略の決定**: + - `main` ブランチ：常にリリース可能な、安定したコードを置く場所とします + - `develop` ブランチ：これから開発する機能や修正を統合していくための、中心的な開発用ブランチとします。mainブランチからこのdevelopブランチを作成します。 + +3. **仕様書の作成**: + - リポジトリの README.md ファイルに、このプロジェクトが「何を」「なぜ」「誰のために」作るのか、という核心的な目的を書き出します。これがプロジェクトの憲法となり、モチベーションの源泉になります。 + +4. **タスクの洗い出しと分解**: + - 仕様書を基に、プロジェクト完成に必要なタスクをすべて洗い出します。 + - 「ユーザー認証機能」のような大きなタスクは、「ログイン画面UI作成」「APIエンドポイント設計」「DBテーブル作成」のように、数時間〜1日で完了できるレベルまで細かく分解します。これは着手のハードルを劇的に下げます。 + +5. **全タスクのIssue化**: + - 分解したタスクを一つ残らず、GitHubのIssueとして作成します。 + - 各Issueには、`feature`（機能追加）、`bug`（バグ）、`chore`（雑務）などのラベルを付け、整理します。 + - 作成したIssueはすべてGitHub Projectsのカンバンボードに追加し、「Todo」カラムに配置します。 + +## 2. 開発フェーズ：集中と柔軟性を両立させる + +### 概要 +計画フェーズで作成したIssue（指示書）に基づき、一つずつタスクをこなしていきます。ここではgit worktreeを最大限に活用し、集中を妨げることなく、興味の波に合わせた柔軟なタスク切り替えを実現します。 + +### 流れ + +1. **Issueの選択**: GitHub Projectsのカンバンボードから、今日取り組むIssueを1つ選び、「進行中」カラムに移動させます。 + +2. **作業場の準備 (git worktree)**: + - ターミナルでメインの作業フォルダ（developブランチがチェックアウトされている場所）にいることを確認します。 + - 取り組むIssue（例: #11）のために、以下のコマンドで新しい作業場（フォルダ）とブランチを瞬時に作成します。 + ```bash + # developブランチを基に、feature/11-login-ui という新しいブランチを作り、 + # ../login-ui-work という新しいフォルダに展開する + git worktree add -b feature/11-login-ui ../login-ui-work develop + ``` + +3. **開発に着手**: + - `cd ../login-ui-work` で新しい作業場に移動し、コーディングに集中します。元の作業フォルダのことは完全に忘れて大丈夫です。 + +4. **コミットとプッシュ**: + - キリの良いところで、こまめにコミットします。コミットメッセージにIssue番号（#11）を入れると、自動でIssueと関連付けられます。 + ```bash + git commit -m "feat: ログインフォームのUIコンポーネントを作成 #11" + ``` + - 作業が完了したら、ブランチをリモートリポジトリにプッシュします。 + ```bash + git push origin feature/11-login-ui + ``` + +5. **プルリクエストの作成**（開発完了後の具体的なアクション）: + - GitHub上で、今プッシュしたfeature/11-login-uiブランチからdevelopブランチへの**プルリクエスト（PR）**を作成します。 + - PRは「この変更を開発用ブランチに加えても良いですか？」というレビュー依頼です。 + - PRの説明欄に `Closes #11` と書くことで、このPRがマージされた時にIssue #11 が自動でクローズされるように設定します。 + +## 3. レビュー＆統合フェーズ（テストフェーズ） + +### 概要 +作成したプルリクエスト（PR）を通じて、変更内容が安全であることを確認し、開発の中心であるdevelopブランチに統合します。ここでの主役は自動化とコミュニケーションです。 + +### 流れ（テストフェーズの具体的な流れ） + +1. **自動テストの実行 (GitHub Actions)**: + - PRが作成されると、それをきっかけ（トリガー）にGitHub Actionsが自動的に起動します。 + - あらかじめ設定しておいたテスト（単体テスト、結合テストなど）が実行され、この変更によって既存の機能が壊れていないかがチェックされます。 + - 結果はPRページに「✔︎ All checks have passed」のように表示され、品質を客観的に保証します。 + +2. **コードレビュー**: + - 他の開発者（あるいは未来の自分）がPRの「Files changed」タブを見て、コードの変更内容を確認します。 + - 「この変数名はもっと分かりやすい方が良い」「ここのロジックはもっとシンプルに書ける」といったフィードバックを、コードの特定の行に対してコメントします。 + +3. **フィードバック対応と修正**: + - レビューコメントを受けたら、自分の作業場（../login-ui-workフォルダ）でコードを修正します。 + - 修正内容をコミットし、再度プッシュします。PRは自動的に最新の状態に更新され、GitHub Actionsによるテストも再実行されます。 + +4. **マージ**: + - すべての自動テストが成功し、レビューで承認（Approve）されたら、PRページの「Merge pull request」ボタンを押します。 + - これで、あなたの変更が安全にdevelopブランチに統合されます。 + +5. **後片付け**: + - developブランチに統合されたので、作業用のブランチと作業場は不要になります。メインの作業フォルダに戻り、以下のコマンドでクリーンアップします。 + ```bash + # メインの作業場に戻る + cd ../my-project + + # 不要になった作業場を削除 + git worktree remove ../login-ui-work + + # 不要になったブランチをローカルとリモートから削除 + git branch -d feature/11-login-ui + git push origin --delete feature/11-login-ui + ``` + +この一連の流れを繰り返すことで、一つ一つのタスクを確実にこなしながら、プロジェクト全体を着実に完成へと導くことができます。 + +## worktreeを使った並行作業の管理 + +複数のIssueを同時に進める場合の具体例： +- Issue #11: ログイン機能を作っている途中 +- Issue #12: 急にバグ修正が必要になった +- Issue #13: UIの改善アイデアが浮かんだ + +```bash +# 現在の作業状況 +../my-project/ # developブランチ（メイン作業場） +../login-work/ # Issue #11用（feature/11-login） +../bugfix-work/ # Issue #12用（hotfix/12-auth-error） +../ui-improve-work/ # Issue #13用（feature/13-ui-improvement） + +# 作業場間の移動は単純にcdするだけ +cd ../bugfix-work # バグ修正に切り替え +cd ../login-work # ログイン機能に戻る +``` + +それぞれの作業場は完全に独立しているので、コミットしていない変更があっても問題なく切り替えられます。 \ No newline at end of file From 6310729265c084d8e504027a20553b1e664cd74c Mon Sep 17 00:00:00 2001 From: marketing-shibata50 Date: Thu, 31 Jul 2025 12:04:18 +0900 Subject: [PATCH 3/4] =?UTF-8?q?feat:=20worktree=E3=82=92=E6=B4=BB=E7=94=A8?= =?UTF-8?q?=E3=81=97=E3=81=9F=E4=B8=A6=E8=A1=8C=E4=BD=9C=E6=A5=AD=E7=AE=A1?= =?UTF-8?q?=E7=90=86=E3=81=AE=E8=A9=B3=E7=B4=B0=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - worktreeの利点と推奨ワークフローを明確化 - 複数のIssueを同時に進める具体例を示す - 機能追加とバグ修正の標準的なワークフローを詳細に記述 - コミット戦略やブランチ名の規則を整理 --- MEMO.md | 545 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 543 insertions(+), 2 deletions(-) diff --git a/MEMO.md b/MEMO.md index e9ca1fe..f68ae2e 100644 --- a/MEMO.md +++ b/MEMO.md @@ -278,7 +278,26 @@ Google スプレッドシートにエクスポート ## worktreeを使った並行作業の管理 -複数のIssueを同時に進める場合の具体例： +### 重要な原則：基本的にすべてのブランチ作成はworktreeで行う + +**なぜworktreeを使うべきか：** +- 現在の作業を一切中断せずに新しいブランチで作業開始できる +- stashやcommitを強制されない +- 複数の作業を自然に並行して進められる +- 心理的な切り替えコストがゼロ + +**推奨ワークフロー：** +```bash +# ブランチを作る時は常にworktree +git worktree add -b feature/新機能 ../新機能-work develop + +# 例外：worktreeを使わない場合 +# - リポジトリを初めてcloneした直後 +# - README.mdのtypo修正などごく簡単な修正 +``` + +### 複数のIssueを同時に進める場合の具体例 + - Issue #11: ログイン機能を作っている途中 - Issue #12: 急にバグ修正が必要になった - Issue #13: UIの改善アイデアが浮かんだ @@ -295,4 +314,526 @@ cd ../bugfix-work # バグ修正に切り替え cd ../login-work # ログイン機能に戻る ``` -それぞれの作業場は完全に独立しているので、コミットしていない変更があっても問題なく切り替えられます。 \ No newline at end of file +それぞれの作業場は完全に独立しているので、コミットしていない変更があっても問題なく切り替えられます。 + +# 機能追加ワークフロー 詳細設計書 + +## 概要 +既存のプロジェクトに新しい機能を追加する際の標準的なワークフローです。これはgit worktreeの真価が最も発揮される場面で、複数の機能開発を並行して進めながら、高品質なコードを維持できます。 + +## 1. 計画フェーズ：アイデアを具体的なタスクに変換 + +### 概要 +新機能のアイデアや要望を、実装可能な具体的なタスクとして定義し、GitHubのIssueとして記録します。 + +### 流れ + +1. **機能要件の明確化**: + - 何を作るのか（What）：ユーザーが実現したいこと + - なぜ必要なのか（Why）：ビジネス価値や問題解決 + - どのように使われるのか（How）：ユーザーストーリー + +2. **Issueの作成**: + ```markdown + タイトル: [Feature] コメント機能の実装 + + ## 概要 + 記事にコメントを投稿できる機能を追加する + + ## 要件 + - [ ] コメント投稿フォーム + - [ ] コメント一覧表示 + - [ ] コメントの削除機能（投稿者のみ） + + ## 技術的な検討事項 + - DBスキーマの追加（commentsテーブル） + - APIエンドポイント（POST /api/comments, GET /api/posts/:id/comments） + - フロントエンドコンポーネント + + ## 受け入れ条件 + - ユーザーがコメントを投稿できる + - 投稿されたコメントが即座に表示される + - 自分のコメントは削除できる + ``` + +3. **ラベルとプロジェクトボードへの追加**: + - `feature` ラベルを付ける + - 優先度（`priority: high/medium/low`）を設定 + - GitHub Projectsの「Todo」カラムに配置 + +4. **タスクの分解**（必要に応じて）: + - 大きな機能は、サブタスクとして別のIssueに分割 + - 例：「コメントUI実装 #25」「コメントAPI実装 #26」 + +## 2. 開発フェーズ：効率的な実装とコミット戦略 + +### 概要 +worktreeを活用して、他の作業を妨げることなく新機能の開発に集中します。 + +### 流れ + +1. **最新のdevelopブランチを取得**: + ```bash + # メイン作業場でdevelopを最新に + cd ../my-project + git checkout develop + git pull origin develop + ``` + +2. **機能用の作業場を作成**: + ```bash + # Issue #24 のコメント機能用 + git worktree add -b feature/24-comment ../comment-work develop + cd ../comment-work + ``` + +3. **開発の進め方**: + - **小さなコミットを重ねる**：機能的な単位でこまめにコミット + - **コミットメッセージの規則**： + ```bash + # 機能追加 + git commit -m "feat: コメント投稿フォームのUIを作成 #24" + + # リファクタリング + git commit -m "refactor: コメント投稿処理を関数に切り出し #24" + + # テスト追加 + git commit -m "test: コメント投稿APIのテストを追加 #24" + ``` + +4. **定期的なプッシュ**: + ```bash + # 作業の区切りでリモートにプッシュ（バックアップ兼進捗共有） + git push origin feature/24-comment + ``` + +5. **他の作業への切り替え**（必要に応じて）: + ```bash + # 急なバグ修正が必要になったら + cd ../my-project + git worktree add -b hotfix/25-urgent ../hotfix-work develop + cd ../hotfix-work + # バグ修正... + + # コメント機能に戻る + cd ../comment-work + # 作業継続（何も失われていない！） + ``` + +## 3. レビュー＆テストフェーズ：品質保証と知識共有 + +### 概要 +プルリクエストを通じて、コードの品質を保証し、チーム内での知識共有を促進します。 + +### 流れ + +1. **セルフレビュー**（PR作成前）: + ```bash + # 自分の変更を確認 + git diff develop...HEAD + + # 不要なデバッグコードやコメントを削除 + # コードフォーマットを整える + ``` + +2. **プルリクエストの作成**: + ```markdown + タイトル: feat: コメント機能を実装 #24 + + ## 概要 + 記事にコメントを投稿・表示する機能を実装しました。 + + ## 変更内容 + - コメント投稿フォームコンポーネント + - コメント一覧表示コンポーネント + - コメントAPI（POST/GET/DELETE） + - DBマイグレーション（commentsテーブル） + + ## テスト方法 + 1. 記事詳細ページを開く + 2. コメントフォームに入力して投稿 + 3. コメントが表示されることを確認 + 4. 自分のコメントの削除ボタンで削除できることを確認 + + ## スクリーンショット + [コメント機能のスクリーンショット] + + Closes #24 + ``` + +3. **自動テストとCI/CD**: + - GitHub Actionsが自動で起動 + - ユニットテスト、統合テスト、Lintが実行される + - テスト結果がPRに表示される + +4. **コードレビューのポイント**: + - **設計の妥当性**：アーキテクチャに沿っているか + - **コードの可読性**：他の人が理解しやすいか + - **テストの充実度**：エッジケースがカバーされているか + - **パフォーマンス**：N+1問題などがないか + - **セキュリティ**：SQLインジェクション対策など + +5. **フィードバック対応**: + ```bash + # レビューコメントに基づいて修正 + cd ../comment-work + # 修正作業... + + git commit -m "fix: レビュー指摘事項を修正（変数名を明確化） #24" + git push origin feature/24-comment + ``` + +## 4. マージ＆デプロイフェーズ：安全な統合と後処理 + +### 概要 +承認された変更を安全にdevelopブランチに統合し、作業環境をクリーンアップします。 + +### 流れ + +1. **最終確認**: + - すべてのテストがパスしている + - レビューで「Approved」を得ている + - コンフリクトが解決されている + +2. **マージ戦略の選択**: + - **Squash and merge**：コミット履歴をきれいにしたい場合 + - **Create a merge commit**：詳細な履歴を残したい場合 + - **Rebase and merge**：直線的な履歴にしたい場合（上級者向け） + +3. **マージ実行**: + - GitHubのPRページで「Merge pull request」をクリック + - Issue #24 が自動的にクローズされる + +4. **作業場のクリーンアップ**: + ```bash + # メイン作業場に戻る + cd ../my-project + + # developを最新に更新 + git checkout develop + git pull origin develop + + # 不要になった作業場を削除 + git worktree remove ../comment-work + + # ローカルブランチを削除 + git branch -d feature/24-comment + + # リモートブランチを削除（任意） + git push origin --delete feature/24-comment + ``` + +5. **次のタスクへ**: + - GitHub Projectsで次のIssueを選択 + - 新しいworktreeで作業開始 + +## ベストプラクティス + +### コミット戦略 +- **頻度**：30分〜1時間に1回はコミット +- **粒度**：1つのコミットは1つの変更 +- **メッセージ**：何を変更したか、なぜ変更したかを明確に + +### ブランチ名の規則 +```bash +feature/{issue番号}-{簡潔な説明} +# 例：feature/24-comment +# feature/25-user-profile +# feature/26-search-api +``` + +### worktreeの整理 +```bash +# 現在のworktreeを確認 +git worktree list + +# 使わなくなったworktreeを定期的に削除 +git worktree prune +``` + +### 並行作業のコツ +- 各worktreeのターミナルタブに分かりやすい名前を付ける +- VSCodeなどのエディタで各worktreeを別ウィンドウで開く +- 作業中のIssue番号をプロンプトに表示する + +# バグ修正ワークフロー 詳細設計書 + +## 概要 +本番環境や開発中に発見されたバグを迅速かつ安全に修正するワークフローです。git worktreeを活用することで、現在の作業を中断することなく、緊急のバグ修正に対応できます。 + +## バグの分類と対応戦略 + +### バグの緊急度による分類 +1. **Critical（緊急）**: 本番環境でサービスが停止、データ損失の危険性 + - 対応：mainブランチから直接hotfixブランチを作成 + - 目標修正時間：即座〜数時間以内 + +2. **High（高）**: 主要機能が動作しない、多くのユーザーに影響 + - 対応：developブランチからbugfixブランチを作成 + - 目標修正時間：24時間以内 + +3. **Medium（中）**: 特定の条件下でのみ発生、回避策あり + - 対応：developブランチからbugfixブランチを作成 + - 目標修正時間：次のリリースまで + +4. **Low（低）**: UIの小さな不具合、影響が限定的 + - 対応：通常の機能追加と同じ扱い + - 目標修正時間：バックログで管理 + +## 1. 計画フェーズ：バグの記録と分析 + +### 概要 +バグを正確に記録し、再現可能な形で文書化します。これにより、修正の効率と品質が大幅に向上します。 + +### 流れ + +1. **バグの報告を受ける**: + - ユーザーからの報告 + - 監視システムからのアラート + - 開発中の発見 + +2. **Issueの作成**: + ```markdown + タイトル: [Bug] ログイン時に特定条件でエラーが発生する + + ## バグの概要 + メールアドレスに「+」記号が含まれる場合、ログインできない + + ## 再現手順 + 1. ログインページにアクセス + 2. メールアドレス「user+test@example.com」を入力 + 3. 正しいパスワードを入力 + 4. ログインボタンをクリック + + ## 期待される動作 + 正常にログインでき、ダッシュボードが表示される + + ## 実際の動作 + 「Invalid email format」エラーが表示される + + ## 環境 + - ブラウザ: Chrome 120.0 + - OS: Windows 11 + - 発生環境: 本番環境 + + ## エラーログ + ``` + Error: Email validation failed + at validateEmail (auth.js:45) + at login (auth.js:123) + ``` + + ## 影響範囲 + - 影響を受けるユーザー数: 約100名（推定） + - 業務への影響: ログインできないため、サービスが利用不可 + + ## 優先度 + High - 多くのユーザーがログインできない + ``` + +3. **ラベルとアサイン**: + - `bug` ラベルを付ける + - 優先度ラベル（`priority: critical/high/medium/low`） + - 必要に応じて担当者をアサイン + +4. **原因の初期分析**: + - エラーログの確認 + - 関連するコードの特定 + - 最近の変更履歴の確認 + +## 2. 開発フェーズ：迅速な修正と検証 + +### 概要 +worktreeを使って現在の作業を保持したまま、バグ修正に集中します。 + +### 流れ + +1. **修正用の作業場を作成**: + ```bash + # 通常のバグ（developから分岐） + cd ../my-project + git worktree add -b bugfix/27-login-validation ../bugfix-login develop + cd ../bugfix-login + + # 緊急のバグ（mainから分岐） + git worktree add -b hotfix/28-critical-auth ../hotfix-auth main + cd ../hotfix-auth + ``` + +2. **バグの再現**: + ```bash + # テスト環境でバグを再現 + # 自動テストを書いて、バグの存在を確認 + npm test -- --grep "email with plus sign" # 失敗することを確認 + ``` + +3. **修正の実装**: + - **最小限の変更**: バグ修正に必要な最小限の変更に留める + - **テストファースト**: まず失敗するテストを書き、それをパスするように修正 + ```bash + # テストを追加 + git add test/auth.test.js + git commit -m "test: メールアドレスに+記号を含む場合のテストを追加 #27" + + # バグを修正 + git add src/auth.js + git commit -m "fix: メールアドレスの+記号を正しく処理するように修正 #27" + ``` + +4. **修正の検証**: + ```bash + # すべてのテストが通ることを確認 + npm test + + # 手動でも動作確認 + npm run dev + # ブラウザで実際に「user+test@example.com」でログインを試す + ``` + +5. **関連する箇所の確認**: + ```bash + # 同じバグが他の箇所にないか確認 + grep -r "validateEmail" src/ + + # 影響範囲の確認 + git diff develop...HEAD + ``` + +## 3. レビュー＆テストフェーズ：品質保証と再発防止 + +### 概要 +バグ修正の品質を保証し、同様のバグの再発を防ぐための対策を実施します。 + +### 流れ + +1. **プルリクエストの作成**: + ```markdown + タイトル: fix: メールアドレスの+記号を正しく処理 #27 + + ## 修正内容 + メールアドレスに「+」記号が含まれる場合にログインできない問題を修正しました。 + + ## 原因 + メールバリデーションの正規表現が「+」記号を許可していなかった + + ## 修正方法 + - 正規表現を修正し、RFC 5322準拠のメールアドレスを受け入れるように変更 + - 該当するテストケースを追加 + + ## テスト + - [x] ユニットテストを追加（+記号を含むメールアドレス） + - [x] 手動テスト完了 + - [x] 既存のテストがすべてパス + + ## 確認項目 + - [x] user+test@example.com でログインできる + - [x] 通常のメールアドレスでも引き続きログインできる + - [x] 不正なメールアドレスは適切に拒否される + + Fixes #27 + ``` + +2. **緊急度に応じたレビュープロセス**: + - **Critical**: 最小限のレビュー後、即座にマージ + - **High**: 通常のレビュープロセス（ただし優先的に） + - **Medium/Low**: 通常のレビュープロセス + +3. **回帰テストの実施**: + ```bash + # 影響を受ける可能性のある機能のテスト + npm test -- --grep "authentication" + npm test -- --grep "user registration" + ``` + +4. **根本原因分析**（RCA）: + - なぜこのバグが発生したか + - なぜテストで検出できなかったか + - 今後の予防策は何か + +## 4. マージ＆デプロイフェーズ：安全なリリースと事後対応 + +### 概要 +修正を本番環境に安全にデプロイし、問題が解決されたことを確認します。 + +### 流れ + +1. **マージ戦略**: + ```bash + # 通常のバグ修正（develop → main） + # 1. developにマージ + # 2. 次回リリース時にmainへ + + # 緊急のバグ修正（hotfix → main & develop） + # 1. mainに直接マージ + # 2. 即座にdevelopにもマージ（同期を保つ） + ``` + +2. **デプロイ前の最終確認**: + - ステージング環境でのテスト + - ロールバック計画の確認 + - 関係者への通知 + +3. **デプロイ実行**: + ```bash + # タグを作成（緊急修正の場合） + git tag -a v1.2.1 -m "Hotfix: Email validation fix" + git push origin v1.2.1 + + # デプロイ（CI/CDまたは手動） + ``` + +4. **デプロイ後の確認**: + - 本番環境での動作確認 + - エラーログの監視 + - ユーザーからのフィードバック確認 + +5. **作業場のクリーンアップ**: + ```bash + # メイン作業場に戻る + cd ../my-project + + # ブランチを最新に + git checkout develop + git pull origin develop + + # 作業場を削除 + git worktree remove ../bugfix-login + + # ブランチを削除 + git branch -d bugfix/27-login-validation + git push origin --delete bugfix/27-login-validation + ``` + +6. **事後対応**: + - 影響を受けたユーザーへの通知 + - ポストモーテム（重大なバグの場合） + - 再発防止策の実装 + +## ベストプラクティス + +### バグ修正の原則 +- **修正は最小限に**: バグ修正時にリファクタリングしない +- **テストファースト**: 必ずテストを書いてからバグを修正 +- **根本原因を修正**: 症状ではなく原因を修正する + +### コミットメッセージ +```bash +# バグ修正 +git commit -m "fix: [影響範囲] 具体的な修正内容 #issue番号" + +# 例 +git commit -m "fix: ログイン時のメールバリデーションエラーを修正 #27" +git commit -m "fix: APIレスポンスのnullチェックを追加 #28" +``` + +### 緊急対応時の心得 +1. **パニックにならない**: worktreeがあるので現在の作業は安全 +2. **手順を守る**: 緊急時こそ手順が重要 +3. **コミュニケーション**: 進捗を適時共有 +4. **記録を残す**: 後で振り返れるように + +### バグの再発防止 +- 同じパターンのバグを自動検出するlintルールの追加 +- テストケースの充実 +- コードレビューのチェックリスト更新 +- ドキュメントの改善 \ No newline at end of file From fc1a75eec12af6b1993ebc7c428f06289eac69fe Mon Sep 17 00:00:00 2001 From: marketing-shibata50 Date: Thu, 31 Jul 2025 21:59:10 +0900 Subject: [PATCH 4/4] =?UTF-8?q?docs:=20MEMO.md=E3=81=ABConventional=20Comm?= =?UTF-8?q?its=E3=81=AE=E8=A9=B3=E7=B4=B0=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - コミットメッセージの標準化に関する概要を記載 - 基本構造と主要なtypeの説明を追加 - 実例を通じて具体的な使用方法を示す - GitHub CopilotやCI/CDとの統合についても言及 --- FLOW.md | 296 ++++ GEMINI.md | 2322 ++++++++++++++++++++++++++++++ GitHub個人開発 最大効率化戦略.md | 2216 ++++++++++++++++++++++++++++ MEMO.md | 537 ++++++- leaked-system-prompts | 1 + worktree-vs-jj-comparison.md | 251 ++++ 6 files changed, 5622 insertions(+), 1 deletion(-) create mode 100644 FLOW.md create mode 100644 GEMINI.md create mode 100644 GitHub個人開発 最大効率化戦略.md create mode 160000 leaked-system-prompts create mode 100644 worktree-vs-jj-comparison.md diff --git a/FLOW.md b/FLOW.md new file mode 100644 index 0000000..b529756 --- /dev/null +++ b/FLOW.md @@ -0,0 +1,296 @@ +# GitHub Development Flow Guide + +このガイドは、Git worktreeを活用した効率的な開発フローをまとめたものです。 + +## 📋 基本的な開発フロー + +### 1. 新規開発の流れ + +#### 計画フェーズ +1. **リポジトリの作成**: GitHub上でプロジェクト用のリポジトリを作成 +2. **ブランチ戦略の決定**: + - `main`: リリース可能な安定版 + - `develop`: 開発統合用ブランチ +3. **仕様書の作成**: README.mdに「何を」「なぜ」「誰のために」を記載 +4. **タスクの洗い出しと分解**: 数時間〜1日で完了できるレベルまで細分化 +5. **全タスクのIssue化**: GitHub Issuesに登録し、Projectsボードで管理 + +#### 開発フェーズ +```bash +# 1. Issueの選択 +# GitHub ProjectsでIssueを「進行中」に移動 + +# 2. worktreeでブランチ作成 +git worktree add -b feature/11-login-ui ../login-ui-work develop +cd ../login-ui-work + +# 3. 開発作業 +# コーディング作業 + +# 4. コミット (Conventional Commits形式) +git add . +git commit -m "feat: ログインフォームのUIコンポーネントを作成 #11" + +# 5. プッシュ +git push origin feature/11-login-ui +``` + +#### レビュー＆統合フェーズ +1. **プルリクエストの作成**: GitHub上でPRを作成（`Closes #11`を含める） +2. **自動テストの実行**: GitHub Actionsが自動でテストを実行 +3. **コードレビュー**: レビュアーがコードを確認 +4. **マージ**: テストとレビューが完了したらマージ +5. **後片付け**: + ```bash + cd ../my-project + git worktree remove ../login-ui-work + git branch -d feature/11-login-ui + git push origin --delete feature/11-login-ui + ``` + +### 2. 機能追加の流れ + +#### 計画フェーズ +1. **機能要件の明確化**: What（何を）、Why（なぜ）、How（どのように）を定義 +2. **Issueの作成**: 要件、技術的検討事項、受け入れ条件を記載 +3. **ラベルとプロジェクトボードへの追加**: `feature`ラベル、優先度設定 +4. **タスクの分解**: 大きな機能はサブタスクに分割 + +#### 開発フェーズ +```bash +# 1. 最新のdevelopを取得 +cd ../my-project +git checkout develop +git pull origin develop + +# 2. 機能用の作業場を作成 +git worktree add -b feature/24-comment ../comment-work develop +cd ../comment-work + +# 3. 開発（小さなコミットを重ねる） +git commit -m "feat: コメント投稿フォームのUIを作成 #24" +git commit -m "test: コメント投稿APIのテストを追加 #24" + +# 4. 定期的なプッシュ +git push origin feature/24-comment +``` + +#### レビュー＆テストフェーズ +1. **セルフレビュー**: 不要なコードの削除、フォーマット確認 +2. **プルリクエストの作成**: 変更内容、テスト方法、スクリーンショットを含める +3. **自動テストとCI/CD**: GitHub Actionsによる自動検証 +4. **コードレビュー**: 設計、可読性、テスト、パフォーマンス、セキュリティ +5. **フィードバック対応**: レビューコメントに基づく修正 + +### 3. バグ修正の流れ + +#### バグの分類 +- **Critical（緊急）**: サービス停止、データ損失の危険 → mainからhotfix +- **High（高）**: 主要機能の不具合 → developからbugfix +- **Medium/Low**: 限定的な影響 → developからbugfix + +#### 修正フロー +```bash +# 1. バグ報告のIssue作成（詳細な再現手順、期待動作、実際の動作、エラーログ） + +# 2. 緊急度に応じたブランチ作成 +# 緊急の場合 +git worktree add -b hotfix/28-critical-auth ../hotfix-auth main + +# 通常の場合 +git worktree add -b bugfix/27-login-validation ../bugfix-login develop + +# 3. バグの再現とテスト作成 +cd ../bugfix-login +# まず失敗するテストを書く +npm test -- --grep "email with plus sign" # 失敗を確認 + +# 4. 修正の実装（最小限の変更） +git commit -m "test: メールアドレスに+記号を含む場合のテストを追加 #27" +git commit -m "fix: メールアドレスの+記号を正しく処理するように修正 #27" + +# 5. 検証 +npm test # すべてのテストがパス +npm run dev # 手動確認 + +# 6. プッシュとPR +git push origin bugfix/27-login-validation +``` + +## 🔄 並列開発のパターン + +### 複数機能の同時開発 + +```bash +# 3つの機能を並行開発 +../feature-login/ # ログイン機能（localhost:3000） +../feature-profile/ # プロフィール機能（localhost:3001） +../feature-dashboard/ # ダッシュボード（localhost:3002） + +# 各ディレクトリで独立して開発サーバーを起動 +cd ../feature-login && npm run dev +cd ../feature-profile && npm run dev -- --port 3001 +cd ../feature-dashboard && npm run dev -- --port 3002 +``` + +### レビュー対応中の新規開発 + +```bash +# PR待ちの間に別の作業を開始 +../feature-A/ # レビュー待ち +../feature-B/ # 新規開発中 +../bugfix-C/ # 緊急修正 + +# レビューコメントが来たらすぐに切り替え +cd ../feature-A +# 修正対応 +git add . +git commit -m "fix: レビュー指摘事項を修正" +git push +``` + +## 🛠️ 便利なコマンド集 + +### worktree管理 + +```bash +# worktree一覧表示 +git worktree list + +# 不要なworktreeの削除 +git worktree prune + +# 特定のコミットからworktree作成 +git worktree add -b feature/test ../test-feature abc123def +``` + +### ブランチ管理 + +```bash +# リモートブランチの最新化 +git fetch --all --prune + +# マージ済みブランチの削除 +git branch --merged | grep -v "\*\|main\|develop" | xargs -n 1 git branch -d +``` + +## 📝 コミットメッセージ規約 + +### Conventional Commits形式 + +``` +(): + + + +