Issue テンプレ:不具合
背景
- 何が起きたか(短文)
目的
- 何を正常化するか(ユーザー影響/業務影響を含める)
スコープ
- 修正対象(画面/機能/API / ジョブ等)
非スコープ
- 今回やらないこと(恒久対応に不要な刷新など)
再現手順
- (記入)
- (記入)
期待結果
- (記入)
実結果
- (記入)
環境
- OS:
- ブラウザ/ランタイム:
- バージョン:
ログ/証跡
- 公開用要約(Issue / PR に記載する、機微情報を含まない事実):
- 公開可否(公開可/マスキング後に公開可/非公開):
- マスキング確認(対象、確認者、確認日):
- 公開用ログ(必要最小限の抜粋):
- 公開用スクリーンショット:
- 非公開証跡の保管先/参照方法(参照 ID、Owner、アクセス申請先):
- 根拠種別(一次情報/実装/検証ログ/二次情報/AI 生成物など):
- 未確定点:
公開 Issue / PR には、秘密情報、個人情報、顧客情報、認証情報、未マスキングの識別子を転記しない。非公開証跡を参照する場合も、機微な保管パスや認証情報は書かず、必要最小限の参照 ID とアクセス可能な Owner への問い合わせ方法だけを記載する。
影響/暫定回避策
- 影響範囲(ユーザー/業務/セキュリティ):
- 暫定回避策(あれば):
責任分界(任意)
- 判断:
- 実行:
- 確認:
受け入れ条件
- Given:
- When:
- Then:
確認方法
- 受け入れ条件を確認するテスト/ログ/画面:
- PR で示す証跡:
記入例(悪い例→良い例)
悪い例
- バグです。直してください。
良い例
- 背景: 決済画面で 500 が発生
- 目的: 決済が完了し、エラー率が通常水準に戻る
- スコープ: 決済 API の入力バリデーションとエラーハンドリング
- 非スコープ: 決済画面のデザイン刷新、決済プロバイダ変更
- 再現手順: 1) カートに追加 2) 決済 3) 500
- 期待: 決済が完了し完了画面へ遷移
- 実: 500 + エラーページ
- 環境: Chrome 122 / macOS 14
- 公開用要約: マスキング済みの再現手順で決済 API が 500 を返し、直近1時間のエラー率が 3.5% まで上昇
- 公開可否: マスキング後に公開可
- マスキング確認: 顧客名、決済情報、token、request-id を除去済み(確認者=Issue Owner、確認日=YYYY-MM-DD)
- 公開用ログ:
status=500 error=validation_failedの必要最小限の抜粋 - 公開用スクリーンショット: 顧客情報を除去したエラー画面
- 非公開証跡の保管先/参照方法: 制限付き記録
EVD-EXAMPLE-001。アクセスが必要な Reviewer は Issue Owner へ申請 - 根拠種別: 再現ログ + アプリケーションログ
- 未確定点: 特定ブラウザのみか全利用者影響かは追加確認
- 影響: 直近1時間の決済エラー率が 0.2%→3.5%(例)、暫定回避策はリトライ案内
- 責任分界: 判断=PM、実行=開発、確認=CS(例)
- 受け入れ条件: Given=決済情報が不正、When=決済、Then=決済は成立せず「原因が分かるエラー」が返る/エラー率が基準値内
- 確認方法: 単体テスト、決済 API のエラーログ、監視ダッシュボード