Contributors Guide to Writing a Good Bug

Revision Information
  • Revision id: 59848
  • Created:
  • Creator: guigs
  • Comment: found bug mentor link
  • Reviewed: No
  • Ready for localization: No
Revision Source
Revision Content

Have you ever wondered as a contributor how the teams find out about some of the issues that come up after a new release? Or maybe that weird thing that that one product did in that weird question you answered yesterday? Well let's admit it, sometimes products break and new ways to use them come up all the time. Or maybe you are that user who has looked under the hood of plently of applications and want to know how to tell -THEM- about it. Whatever the case, this article will give a few guidelines on how to communicate that weird situation or error code you saw in that one question and translate it into something an engineer can work from.

This is where bugzilla comes in. Bugzilla is the tool that Mozilla uses to talk about the bugs in all of the products that Mozilla has ever created, for the most part. But out neighbors have an ecosystem just like the forum. All of its wonders will be found in due time. Just like the cave of wonders, for now, do not touch anything but the lamp!


Bugzilla and what it can do

[add screenshot of bugzilla] This is bugzilla, and below is a bug form. [add a screenshot of File a bug] If you are looking for an existing bug his is the search functions [screenshot of the search functions]

What you need to know before you participate

Please keep these in mind before you enter Bugzilla of wonders:

  • Please read the ediquette
  • Did you find a bug that describes what you are seeing? ok do they have the same info you have? let them know or vote on it

How to gather the troubleshooting info for the bug

So you are already good at this stuff: asking for what the user is seeing on their computer screen or phone and how to show them the basics. Now for the more technical stuff.

Troubleshooting information on about:support

  1. Open Firefox and type in about:support
  2. Look for the Copy text to clipboard
  3. Paste the information below

Questions you can ask yourself to frame the bug and description

  1. Does it happen in firefox Safe Mode and a new profile?
  2. What add ons do you have? What version do you use?
  3. Can you reproduce this?or do eyou know someone who can?
  4. Ok is there another way to do it in the mean time, is there a work around?

is it working the way that it intended to work?

Existing Guidelines for Writing your First bug

Mozilla has a wiki paget that walks a first time user on how to write an affective bug. Just like SUMO, there is some lingo and guides to being amazing. Please seeHow to write an amazing bug

Guidelines on how to get help:

  • Please make sure all comments on bugs are useful peices of information in helping solve the bug.
  • Do not fear we are not leading you to a wasteland of forgotten bugs. Each component sends an email to the owner of that component
  • Each bug is reviewed, triages and viewed by many people, this is why it is important to make sure it has clear information in its description. xbut make sure that if it is not assigned that you put a severity on it, the severity gets more attention in those components.
  • If you have any questions about this please seek a moderator or and admin for more help. Some places to find help are irc channel that it pertains to and ask about it, if you get an employees attention to keep track of the thread they can ask more questions if they are working on improving that as well
  • Tell the [input.mozilla.org] if it is feedback !


Support: If you find the bug matching thier issue:

  • Tell them the priority and what that means
  • has is been assigned or does it depend on another
  • has it been fixed in auroa or nightly?
  • contact the engineer if it is assigned? status update?

For example, this is not a standard:

Currently it looks like this bug depends on a [prority] bug, which is the highest priority. I have voted on this bug and recommend you check for updates on this issue on this bug and vote as well because it is affecting you. In the meantime we are happy to help find a work around.

  • [Insert work around if there is one]
  • If the behavior is the same is there a time the bug says it will be fixed? Be careful here becuase this is subject to change and can be left out.

We are very sorry for the inconvenience. If there are any other questions in the meantime please do not hesitate to ask.

  • Start a new thread can be added.


Firefox for Android

HOW TO GATHER TROUBLESHOOTING INFO

=Firefox OS Troubleshooting info=HOW TO GATHER TROUBLESHOOTING INFO HOW TO GATHER TROUBLESHOOTING INFO This is a template for some bugs that is useds.

Hi,

>> Please

 type%2

0a brief introduction to the bug and/or background if it would be helpful to the Engineering and QA teams. Not required for all bugs - some of them are simpler and straight forward.

STEPS TO REPRODUCE:

EXPECTED RESULTS:


ACTUAL RESULTS:

Please let me know if there is any information I could provide to help with the investigation and troubleshooting of this issue.

Thanks!!


Magic link for description of bug components: https://bugzilla.mozilla.org/describecomponents.cgi?=

Some common Webmaker troubleshooting info

HOW TO GATHER TROUBLESHOOTING INFO

Some common Thunderbird troubleshooting info

HOW TO GATHER TROUBLESHOOTING INFO


I filed some bugs, but I want to do a little more

Now you start to file some bugs, but you want a little more. Ok have they been assigned? Have there been any updates? This is a big part of support.

...Getting to know components, check out their descriptions if you have questions. Click on this and choose a product.

...Ok you want to be one of the bugmasters, enter the Mulan theme song [http://youtu.be/eGMN-gNfdaY Be a man - mulan]

...Or Ok, maybe you want to find the right people to take a look at a bug: Mdn’s guide to bugzilla: they will tell you all about the etiquette, how to fix it and where to find the right people.

...Or maybe you know how to fix it?

... Maybe you are really good at this and could be a mentor or need one?

Some Examples of Support for Bugs that are In Progress

[Add a video or slide deck]