メインコンテンツまでスキップ

issueで不具合を報告する

issueは不具合だけでなく、改善提案や作業の管理にも使われます。このページでは不具合報告に絞り、別の人が再現できる情報と、確認済みの事実を英語で残す練習をします。以下は例文です。

報告例:期待する結果と実際の結果を分ける​

既存のissueとテンプレートを確認してから、対象の機能と現象がわかるタイトルを付けます。

Title: Search panel remains loading after a network error

Environment:
- App version: 2.4.0
- Browser: Chrome on Windows
- Environment: staging

Steps to reproduce:
1. Open the search panel.
2. Disconnect the network.
3. Search for "sample".

Expected result:
An error message appears and the loading indicator disappears.

Actual result:
The loading indicator remains visible and no error message appears.

Frequency:
Reproduced in 3 out of 3 attempts in the environment above.

Impact:
Users cannot tell that the request failed.

Evidence:
Sanitized console output is attached.
The cause has not yet been confirmed.

日本語の意味: アプリ2.4.0、WindowsのChrome、ステージング環境で、検索パネルを開き、ネットワークを切断してsampleを検索すると発生します。期待する結果はエラー表示と読み込み表示の終了ですが、実際は読み込み表示が残り、エラーが表示されません。この環境で3回中3回再現し、ユーザーはリクエストの失敗を判断できません。秘密情報などを除いたコンソール出力を添付しており、原因は未確認です。

Reproduced in 3 out of 3 attempts in the environment above.

上記の環境で、3回の試行中3回再現しました。

速度 1.0 / 自動選択 / en-US

ブラウザーやOSの具体的なバージョン、設定、必要なテストデータも、再現に関係する場合は補います。3回の試行結果を「どの環境でも必ず起きる」と一般化しないようにします。

技術的な症状と、業務への影響を分ける​

「エラーが出る」という症状に加え、どの業務が止まり、何人・何件が影響を受け、いつまでに対応が必要かを別の欄で記録します。ただし、アカウント数を人数とみなしたり、失敗したリクエスト数に再試行が含まれることを省いたりしないようにします。

The issue is confirmed in staging; production impact has not yet been assessed.

ステージング環境では問題を確認していますが、本番環境への影響はまだ評価していません。

速度 1.0 / 自動選択 / en-US

未確認の影響を0として記録しません。人数・金額の根拠、直接費用と間接影響、受け取った情報の評価は業務影響を記録・評価する、顧客への配慮ある聞き方は顧客に業務への影響を確認するで扱います。

再現しないとき:範囲を限定して返す​

I could not reproduce this in version 2.4.1 with the default settings. Could you share the browser version and any non-default settings?

バージョン2.4.1の初期設定では再現できませんでした。ブラウザーのバージョンと、初期設定から変更した設定を共有していただけますか?

速度 1.0 / 自動選択 / en-US

Cannot reproduceだけで報告を否定せず、試した条件と不足情報を示します。再現しなかったことは、問題が存在しない証明ではありません。

仮説・回避策・修正を区別する​

The request failure handler may be leaving the loading state unchanged. This is a hypothesis, not a confirmed cause.

リクエスト失敗時の処理で読み込み状態が更新されていない可能性があります。これは仮説であり、確認済みの原因ではありません。

速度 1.0 / 自動選択 / en-US

Reloading the page is a temporary workaround; it does not fix the underlying issue.

ページの再読み込みは一時的な回避策であり、根本の問題を修正するものではありません。

速度 1.0 / 自動選択 / en-US

The fix is included in version 2.4.2. We verified the reproduction steps in staging, but production verification is still pending.

修正はバージョン2.4.2に含まれています。ステージング環境で再現手順を検証しましたが、本番環境での検証はまだです。

速度 1.0 / 自動選択 / en-US

issueを閉じる基準はチームの運用に従います。修正をマージしたこと、リリースしたこと、利用者の環境で解消したことは区別します。

公開issueに秘密情報を載せない

ログ、画像、URL、テストデータから、トークン、個人情報、顧客情報などを除きます。脆弱性の可能性がある報告は、公開issueではなくプロジェクトの指定する非公開の報告経路を確認してください。

関連記事・参考資料​