バグ報告の方法

ショートカット: BUGREPORT
From mediawiki.org
This page is a translated version of the page How to report a bug and the translation is 97% complete.


Phabricator は、ソフトウェアのバグ報告、機能リクエスト、企画作業のためのものです。
  • ウィキメディアのプロジェクト群についての技術的な質問は、m:Tech を参照してください
  • WMF (ウィキメディア財団) 以外のインストレーションの MediaWiki についての技術的な質問は、Project:サポートデスク を参照してください。

このガイドラインは、ウィキメディアのタスクトラッカー (詳細は Phabricator を参照してください) における、適切なバグ報告や機能追加リクエスト(タスク)の書き方について解説しています。タスクは適切に書かれているほど実行されやすくなります。 タスクは英語で書く必要があります。英語で書けない場合は、Google 翻訳などの機械翻訳ツールをお試しください。

報告の要点

  • 正確に。
  • 明確に。すなわち、1) バグの状況を再現する方法、2) 想定している挙動、3) 実際の挙動という3点を、節を分けて、異なった解釈の余地のないように説明してください。
  • 1つのタスクでは1つの特定のバグ、もしくは特定の特徴についての要求のみを扱ってください。
  • 関連のあるリンクや例を含めてください。

何かをする前に

問題点を再現できますか?

あなたのバグが最新のソフトウェアで再現されるかどうかを試し、すでに修正されているかどうかを調べてみてください。ウィキペディア等のウィキサイトでそのバグが起こっているなら、最新バージョンのソフトウェアをtest2.wikipedia.orgで試すことができます。

他の誰かが既に報告した問題点ではありませんか?

ウィキメディアのバグトラッカーの検索ボックスを使用し、あなたのバグが既に報告されたかどうかを確認して下さい。詳細な検索ページを用いて、より細かい条件での検索も行えます。

バグが既に報告されているかどうか不明な場合は、そのバグを報告すべきです。バグが報告されないままになるよりは、重複してもバグが報告された方がよいです。

ガジェットもしくはUIスクリプトに問題があるのでは?

問題によっては使用する利用者スクリプトやガジェットのエラーが原因かもしれません。 問題のレポートで時間をつぶすよりも、それらコードを探す手順のガイドに従うと 問題が解決できる可能性があります。

Is it a caching issue?

Some issues relate to older cached HTML being served alongside newer JavaScript where the two are incompatible. To help determine if this is the cause it is helpful to purge the page, refresh the page and see if the issue persists and include this information in your bug report.

新しいバグの報告や指摘

最新バージョンでバグが見つかり、それが他の誰もまだ報告していないバグであれば:

  1. phabricator.wikimedia.org に移動します。
  2. ログイン (または登録) する必要がありますので、求められた場合はそうしてください (アカウントの作成 を参照してください)。
  3. 右上角のブックマークボタンをクリック、「ソフトウェアのバグを報告」を選択 (もしくはセキュリティ上の問題を報告 ページで「セキュリティ問題を報告」する。)
  4. 以下のうち少なくともひとつの項目に記入してください:
    • Title(題名): (あなたが提案する解決法ではなく) 問題点を説明する短い要約を述べた1文。
      • いい例: "Selecting gender is not functional on Special:Preferences"
      • 悪い例: "Software crashes"
    • Description (説明): 問題点の完全な詳細として、現在持っているすべての情報を提供します。 それでも不十分な場合は、入手方法のガイダンスとともに追加情報を得られます。 以下のフィールドを含めてください:
      • バグの場合:
        • Steps to Reproduce (再現の手順): 述べられている問題を引き起こすための、簡単に行える最小の手順を書いてください。特殊な準備手順があれば書いてください。
          例:
          1. Go to https://en.wikipedia.org with Internet Explorer version 10.0;
          2. Make sure you are logged in;
          3. Select "My Preferences" menu;
          4. Go to "Gender" and select female gender from box list;
          5. Click "Save" button.
        • Actual Results (実際の結果): 上記の手順をたどったとき、アプリケーションが行ったこと。
          例:
          "There is no female gender in front of my username."
        • Expected Results (期待される結果): バグがない場合にアプリケーションが行うべきだったこと。
          例:
          "My gender is shown in front of my username."
      • 機能の要望の場合:
        • あなたが望むものとその理由の記述。 機能で解決したい課題を、具体的な実例入りで説明 (実際に何が問題か) します。ただし解決策を押し付けないでください。他の選択肢やより良い対策が見つかる可能性があります。 ユーザー ストーリーは、要望の伝達方法として効果的です。
          例:
          "As a new editor, I would like to be acknowledged for my contribution to the project, so that I feel welcomed and valued"
      • 他に有用かもしれない情報があれば書いてください。例えば:
        • そのバグに遭遇したとき使用していたブラウザー、外装、コンピューターシステム
        • そのバグに遭遇したページ (複数可) の差分またはリンク
        • 問題がいつも生じるか、一部のページや特定の条件でだけ生じるか
    • ログファイルやスクリーンショット を添付する場合 (ただし決して機密情報をふくんだり表示したりしないように) 、Description フィールドにある Upload File ボタン (雲に矢印の形) をクリックします。
    • バグが見つかったタグ (プロジェクト) を選択してください:
      • 開発者はプロジェクトを利用して作業するタスクを探します。検索機能(右上)を使用して説明を探し、適切なプロジェクトを特定します。
      • 例えばウィキソフトウェア自体の場合は MediaWiki-General-or-Unknown プロジェクト、ウィキメディアのサイトの設定の場合は Wikimedia-Site-Requests などとなります (Selecting projects を参照)。
    • 購読者: このタスクについて連絡を受けたそうな利用者を、具体的に思い当たるなら、その人をここに追加してください。 さもなければ、このフィールドは気にしなくて構いません。

報告が完成したことを確認してから、"Create Task" ボタンをクリックしてください。バグ報告がデータベースに登録されます。 この手続きで、報告に関心を持った誰かに詳細が伝わり 作業開始に結びつくきっかけができます

タスクの優先度は、開発者がタスクの実行を計画するときに決めます (優先度の設定 も参照してください)。

以上です。MediaWikiとウィキメディアプロジェクトの改善にご協力くださいましてありがとうございます。

JavaScript のバグの報告

関連項目: Help:壊れたスクリプトを特定する

さまざまな機能つまりガジェットや利用者スクリプト、MediaWikiの各部分が JavaScriptに依存しています。

JavaScript に関連する可能性があるバグを見つけた時は、できるだけエラーメッセージを特定し、バグ報告にコピーしてください。

システム管理者でさえエラーログにアクセスすることができないため、あなたのところにある情報をすべて提供していただくことが特に重要です。

問題が利用者スクリプトのコードまたはガジェット本体にある場合、取り扱う場所は Phabricator ではないかもしれません[1]。他の利用者がスクリプトの議論のページにリダイレクトしてくれることがあります (問題のあるスクリプトが特定できた場合)。

接続性の問題の報告

ウィキメディアのウェブサイトに接続するのに困難がある場合は (インターネット接続が遅い、など)、https://wikitech-static.wikimedia.org/wiki/Reporting_a_connectivity_issue に従ってください。

ログインの問題点の報告

アカウントにログインできない場合は、Manual:デバッグの方法/ログインの問題点 の手順に従ってください。

注記

関連項目