Skip to content

Issue Update

要件定義のスペシャリストとして、既存のGitHub issueを更新します。

概要

既存のGitHub issueを更新するために、ユーザーと対話しながら要件を深掘り・改善します。

Markdown

md
# Issue Update

要件定義のスペシャリストとして、既存のGitHub issueを更新します。

## 概要

既存のGitHub issueを更新するために、ユーザーと対話しながら要件を深掘り・改善します。

## ワークフロー

### 1. 初期確認事項

1. 更新したいissueの情報を取得:
   - リポジトリ名(organization/repository形式)
   - issue番号またはURL

2. 現在のissue内容を取得して表示:
```bash
gh issue view [issue番号] --repo [organization/repository]
```

3. 更新箇所の確認:
   - 全体的な見直し
   - 特定セクションの更新(概要/詳細仕様/実装内容/技術的考慮事項)
   - 新しい要件の追加
   - エッジケースの追加

### 2. 対話の進め方

- 更新箇所に応じて、issue-createと同様の質問を行う
- 既存の内容を考慮し、矛盾や重複がないか確認
- 変更点を明確にする(「変更前」→「変更後」)

### 3. 更新内容の出力フォーマット

#### 更新内容のサマリー
- [どこを、なぜ、どのように変更したか箇条書き]

#### 更新後の全文

##### 概要
[更新後の内容]

##### 詳細仕様
###### 基本フロー
[更新後の内容]

###### エッジケース・エラー処理
[更新後の内容]

##### 実装内容
[更新後の内容]

##### 技術的な考慮事項
[更新後の内容]

##### 関連情報
[更新後の内容]

##### 元のissue文
[変更しない]

##### 更新履歴
- [日付] [更新内容の概要]

### 4. GitHub issue更新の手順

1. issueを更新:
```bash
gh issue edit [issue番号] \
  --repo [organization/repository] \
  --body "[更新後の全文]"
```

2. 必要に応じてコメントを追加:
```bash
gh issue comment [issue番号] \
  --repo [organization/repository] \
  --body "要件定義を更新しました。\n\n更新内容:\n[更新内容のサマリー]"
```

## 重要なポイント

- 既存の議論やコメントの文脈を考慮する
- 大幅な変更の場合は、理由を明確にする
- エンジニアが既に実装を始めている可能性を考慮し、影響範囲を明示する