How to report a bug

From MediaWiki.org
Jump to: navigation, search

Other languages:
беларуская (тарашкевіца)‎ • ‎български • ‎català • ‎čeština • ‎Cymraeg • ‎dansk • ‎Deutsch • ‎Ελληνικά • ‎English • ‎British English • ‎Esperanto • ‎español • ‎euskara • ‎suomi • ‎français • ‎galego • ‎Hawai`i • ‎עברית • ‎हिन्दी • ‎hrvatski • ‎magyar • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎ქართული • ‎ಕನ್ನಡ • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎Bahasa Melayu • ‎Napulitano • ‎norsk bokmål • ‎Nederlands • ‎occitan • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎русский • ‎Scots • ‎shqip • ‎svenska • ‎தமிழ் • ‎తెలుగు • ‎українська • ‎ייִדיש • ‎中文 • ‎中文(繁體)‎

These guidelines explain how to write a good bug report or feature request in Wikimedia's bugtracker (see Phabricator for more information). Effective bug reports are the most likely to be fixed.


Quick recommendations for reports[edit | edit source]

  • Be precise
  • Be clear: explain how to reproduce the problem, step by step, so others can reproduce the bug
  • Include only one problem per report

Before you do anything[edit | edit source]

Can you reproduce the issue?[edit | edit source]

Try to reproduce your bug using a recent version of the software, to see whether it has already been fixed. If the bug is on a wiki site like Wikipedia you could try testing the latest software version on test2.wikipedia.org.

Has someone else already reported the issue?[edit | edit source]

Use the search box of Wikimedia's bugtracker to see if your bug has already been reported. You can also perform more advanced searches on the advanced search page.

Reporting a new bug or feature request[edit | edit source]

If you have faced a bug in a recent version and no one else appears to have reported it, then:

  1. Go to phabricator.wikimedia.org and click "Maniphest" in the side bar.
  2. Choose "Create task" in the upper corner.
  3. You will be asked to log in (or register) if you have not already done so (see "Creating your account").
  4. Fill out at least the following fields:
    • Title: A short one-sentence summary that explains the problem (not your suggested solution).
      • Good: "Selecting Gender is not functional."
      • Bad: "Software crashes."
    • Assigned to: You can ignore this field: Developers will set an assignee when they plan to work on the task.
    • CC: You can ignore this field: If you know specific users who will be interested in getting notified of this task you can add them here.
    • Priority: You can ignore this field: In general, the priority is set by developers who plan to work on the task (see "Setting priorities").
  5. Select the project(s) in which you've found the bug:
    This could be for example the MediaWiki-General-or-Unknown project for the wiki software itself, or Wikimedia-General-or-Unknown for configuration changes of the Wikimedia wiki sites (see "Selecting projects").
    • Security: Set this to "Security or Sensitive bug" if many users could be harmed by the security problem that you are reporting. Your report will be kept hidden from the public until it is resolved.
    • Description: Full details of the issue, giving as much detail as possible. This can include:
      • For bugs:
        • Steps to Reproduce: Minimized, easy-to-follow steps that will trigger the described problem. Include any special setup steps.
          Example:
          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: What the application did after performing the above steps.
          Example:
          "There is no female gender in front of my user name."
        • Expected Results: What the application should have done, if there was no bug.
          Example:
          "My gender is shown in front of my user name."
      • For feature requests:
        • A description of what you would like to achieve, and why. A user story is an effective way of conveying this.
          Example:
          "As a new editor, I would like to be acknowledged for my contribution to the project, so that I feel welcomed and valued"
      • Please also provide any other information that might be useful, such as:
        • the web browsers, skins, or computer systems you've seen the bug on;
        • links or diffs to one or more pages where you encountered the bug; or
        • whether the problem appears every time, only occasionally, only on certain pages, or only in specific circumstances.
    • To attach a log file or screenshot (but make sure that no confidential data is included or shown), click the Upload File button (a cloud with an arrow) in the tool bar of the Description field.

Check if your report is complete, then press the "Create Task" button. Your report will now be in the database and somebody will hopefully take a look at it soon.

That's all! Thanks for your help to improve MediaWiki and Wikimedia projects!

See also[edit | edit source]