issue-fix-flow

GitHub Issue 修正フロー

概要

gh CLI、ローカルでの編集、git を使用して、課題の受付から修正、検証、プッシュまで GitHub の課題を解決します。

ワークフロー

1) 受付と課題のコンテキスト

課題の全コンテキストを取得します：

gh issue view <id> --comments

リポジトリが不明な場合：

gh repo view --json nameWithOwner

課題から以下を記録します：

• 再現手順
• 期待される動作
• メンテナーのメモやラベル
• 関連する課題や PR

2) コードパスの特定

関連するコードを検索します：

# Find files related to the issue
rg -n "keyword from issue"

# Find function definitions
rg -n "func relevantFunction"

# Find type definitions
rg -n "struct|class|enum RelevantType"

関連するコードパスを読み、以下を把握します：

• エントリーポイント
• データフロー
• 既存のパターンと規約

3) 修正の実装

ガイドライン：

• 編集するファイルは必要最小限にします
• 既存のアーキテクチャとスタイルに沿って変更します
• 動作に変更があり、テストでカバーすることが現実的な場合はテストを追加します
• リポジトリ固有の規約に従います（CONTRIBUTING.md、AGENTS.md、CLAUDE.md を確認してください）

4) ビルドとテスト

Swift/Xcode プロジェクトの場合：

# Build
swift build
# or
xcodebuild -scheme MyApp -destination 'platform=macOS' build

# Test
swift test
# or
xcodebuild -scheme MyAppTests -destination 'platform=macOS' test

その他のプロジェクトでは、適切なビルド／テストコマンドを使用します。

警告や失敗を報告してください。隠してはいけません。

5) コミットとプッシュ

無関係な変更がないか確認します：

git status --short
git diff

修正分のみをステージします：

git add <specific files>

課題をクローズするメッセージを付けてコミットします：

git commit -m "Fix: <description>

Closes #<issue number>"

プッシュします：

git push

6) 結果の報告

以下の内容をまとめて報告します：

• 変更内容と変更箇所
• テスト結果（失敗も含む）
• 今後の対応事項や、作業を妨げている項目

クイックリファレンス

タスク	コマンド
課題を表示	gh issue view <id> --comments
課題一覧を表示	gh issue list
リポジトリを表示	gh repo view --json nameWithOwner
ブランチを作成	git checkout -b fix/issue-<id>
ファイルをステージ	git add <files>
コミット	git commit -m "Fix: ... Closes #<id>"
プッシュ	git push -u origin HEAD
PR を作成	gh pr create --fill

コミットメッセージの形式

Fix: Brief description of the fix

More detailed explanation if needed.
- What was the problem
- How it was fixed
- Any notable changes

Closes #123

ブランチの命名

# Feature
git checkout -b feature/issue-123-add-feature

# Bug fix
git checkout -b fix/issue-123-fix-bug

# Refactor
git checkout -b refactor/issue-123-cleanup

PR ワークフロー（任意）

PR 用のブランチで作業する場合：

# Create branch
git checkout -b fix/issue-<id>

# Make changes, commit
git add .
git commit -m "Fix: description (closes #<id>)"

# Push and create PR
git push -u origin HEAD
gh pr create --fill

チェックリスト

• 課題のコンテキストを記録した（再現手順、期待される動作）
• コードパスを特定し、把握した
• 最小限の変更で修正を実装した
• 該当する場合、テストを追加／更新した
• ビルドが成功する
• テストが成功する
• 関連するファイルのみをステージした
• コミットメッセージに Closes #<id> を含めた
• 変更をプッシュした
• 概要を報告した