GeezerVison

These guidelines explain how to write a good bug report or feature request (a task) in Wikimedia's task tracker (see Phabricator for more information). Well-written tasks are more likely to be worked on quickly.

• Be precise
• Be clear: explain 1) how to reproduce the situation, step by step, without leaving any room for interpretation, 2) expected behaviour, 3) actual behaviour. In separate sections.
• Include only one specific bug or one specific feature request per task.
• Include any relevant links and examples.

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.

Use the search box of Wikimedia's task tracker to see if your bug was already reported, or the feature requested. You can also perform more advanced searches on the advanced search page.

If you are unsure whether a bug has already been reported, you should report the bug. It is better to have duplicate bugs than it is to have unreported bugs.

Some problems are a consequence of using user scripts and gadgets which need some fixes. There is a guide available with steps how you can identify such code, which could fix your issue so that you do not waste your time reporting it.

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.

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.
2. You will have to log in (or register) if you have not already done so (see "Creating your account ").
3. Click the Bookmark button in the upper right corner and choose "Report a Software Bug" (or "Report a Security Issue" to report a security problem ).
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 on Special:Preferences"
     • N Bad: "Software crashes"
   • Description: Full details of the issue, giving all the information you currently have. If that is insufficient you will be asked for additional information along with guidance on how to obtain it. This field should include:
     • For bugs:
       • Steps to Reproduce: Minimised, 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 username."

       • Expected Results: What the application should have done, if there was no bug.

         Example:

         "My gender is shown in front of my username."

     • For feature requests:
       • A description of what you would like to achieve, and why. Explain what you hope the feature will solve (the actual underlying problem) along with specific examples; but do not demand a specific solution, as there might be other/better solutions. 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.
   • Select the tags (project(s)) in which you've found the bug:
     • Projects are how developers find tasks to work on. To identify the right project(s), use the search function (in the top right) to find its description.
     • This could be for example the MediaWiki-General project for the wiki software itself, or Wikimedia-Site-Requests for configuration changes on a Wikimedia site (see Selecting projects ).
   • Subscribers: If you know specific users who will be interested in getting notified of this task you can add them here. Otherwise, ignore this field.

Check if your report is complete, then press the "Create Task" button. Your report will now be in the database. This allows somebody interested in the report to look at it and potentially work on it .

The priority for the task will be set by developers if they plan to work on the task (see Setting priorities).

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

See also: Help:Locating broken scripts

A lot of functionality, such as gadgets, user scripts, and some parts of MediaWiki, rely on JavaScript.

When you encounter a bug that may be related to JavaScript, do your best to identify error messages and copy them into the bug report.

It's especially important to provide all the information you have, because even the system administrators will have zero access to any error log.

If the problem is in the code of a user script or gadget itself, then Phabricator might not be the place where the problem will get handled.^[1] Someone might redirect you to the talk page of the script (if the problematic script is identified).

If you are having difficulties reaching a Wikimedia website at all (slow internet connection etc.), please follow Reporting a connectivity issue.

If you are having problems logging into your account, please follow Manual:How to debug/Login problems .

• How to Report Bugs Effectively by Simon Tatham
• Wikimedia Phabricator
  • Phabricator etiquette
• Bug management/Bug report life cycle
• Writing a good bug report or feature request
• English Wikipedia: Bug reports and feature requests

Retrieved from "https://www.mediawiki.org/w/index.php?title=How_to_report_a_bug&oldid=8217593"

Category:

• Phabricator