How to report a bug

From MediaWiki.org
Jump to: navigation, search

Other languages:
čeština 100% • ‎Cymraeg 2% • ‎dansk 83% • ‎Deutsch 100% • ‎Ελληνικά 12% • ‎English 100% • ‎British English 5% • ‎español 98% • ‎euskara 2% • ‎français 64% • ‎galego 12% • ‎עברית 17% • ‎hrvatski 19% • ‎magyar 14% • ‎italiano 88% • ‎日本語 98% • ‎ಕನ್ನಡ 19% • ‎한국어 48% • ‎Lëtzebuergesch 57% • ‎lietuvių 33% • ‎norsk bokmål 50% • ‎Nederlands 36% • ‎occitan 2% • ‎polski 79% • ‎português 33% • ‎português do Brasil 98% • ‎русский 100% • ‎Scots 98% • ‎shqip 19% • ‎svenska 98% • ‎తెలుగు 14% • ‎українська 98% • ‎ייִדיש 26% • ‎中文 67%

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

Try the new guided form to file bugs!

A screencast is available to find out more about how the new guided form works.


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 on bugzilla.wikimedia.org to see if your bug has already been reported. You can also perform more advanced searches on the 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 bugzilla.wikimedia.org.
  2. Choose "Enter a new bug".
  3. You will be asked to log in (or register) if you have not already done so (see "Why must I register?").
  4. Select the product in which you've found the bug:
    This could be for example MediaWiki for the wiki software itself, or Wikimedia for configuration changes of the Wikimedia wiki sites.
  5. Fill out at least the following fields:
    • Component: The part of the software the bug happens in. On the right you can see descriptions for each component. If none seems appropriate, use General/Unknown.
    • Severity: If you request a new feature, please set the severity to enhancement.
    • Summary: A short one-sentence summary that explains the problem (not your suggested solution).
      • Good: "Selecting Gender is not functional."
      • Bad: "Software crashes."
    • Description: Full details of the issue, giving as much detail as possible. This can include:
      • 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."
      • 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.
    • Attachment: You may attach a log file or screenshot (but make sure that no confidential data is included or shown).

Check if your report is complete, then press the "Submit bug" button. Your bug 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]