BMO/How to Use Bugzilla: Difference between revisions

Line 78: Line 78:
===Bugzilla Helper===
===Bugzilla Helper===
If you're new to bugzilla.mozilla.org, reporting a new bug takes you to the Bugzilla Helper form (you can also always find it at https://bugzilla.mozilla.org/enter_bug.cgi?format=guided). The Helper form walks you through three steps in filing a bug.
If you're new to bugzilla.mozilla.org, reporting a new bug takes you to the Bugzilla Helper form (you can also always find it at https://bugzilla.mozilla.org/enter_bug.cgi?format=guided). The Helper form walks you through three steps in filing a bug.
===== Before starting to log a new bug is important to:=====
*Make sure that the issue is still reproducible and it was not only a one time issue
*Make sure that the issue is reproducible with a [https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles clean profile]
*Make sure that the issue is reproducible only on Firefox browser and is not a problem with the website. Try to reproduce the issue on other browsers(eg. Google Chrome)
*Make sure that the issue is not already logged


'''Step 1 of 3: Choose a product.'''
'''Step 1 of 3: Choose a product.'''
<div class="toccolours mw-collapsible mw-collapsed" style="width:auto">
Screenshot
<div class="mw-collapsible-content">
'''[[File:BMO-bugzilla-helper1.png]]
</div></div>


Depending on what you are reporting, there may be better options than Bugzilla.  The top section lists some of this, including Mozilla's [https://support.mozilla.org/ Support] and [https://input.mozilla.org Feedback] sites.
Depending on what you are reporting, there may be better options than Bugzilla.  The top section lists some of this, including Mozilla's [https://support.mozilla.org/ Support] and [https://input.mozilla.org Feedback] sites.


If your bug is in a Mozilla product, select it from the list under "None of the above; my bug is in:". It might in Firefox, Firefox for Android, or some other product. Click the one that is your best guess.
If your bug is in a Mozilla product, select it from the list under "None of the above; my bug is in:". It might in Firefox(for bugs found in Firefox web browser), Firefox for Android, Firefox for iOS, or some other product. Click the one that is your best guess.
 
[[File:BMO-bugzilla-helper1.png]]


'''Step 2 of 3: Summarize the bug.'''
'''Step 2 of 3: Summarize the bug.'''


Write a short summary of your bug. It should be specific, clear, descriptive, and searchable. Think of it as a title for the bug. There is also a specific option for translation errors.   
Write a short summary of your bug. It should be specific, clear, descriptive, and searchable. Think of it as a title for the bug. There is also a specific option for translation errors.   
[[File:BMO-bugzillahelper2a.png]]


After you type in your bug summary, click the "Find similar issues" button. You will get a list of bugs that may be similar to yours.  
After you type in your bug summary, click the "Find similar issues" button. You will get a list of bugs that may be similar to yours.  


[[File:BMO-bugzillahelper2b-findsimilar.png]]
<div class="toccolours mw-collapsible mw-collapsed" style="width:auto">
Screenshot
<div class="mw-collapsible-content">
'''[[File:BMO-bugzillahelper2b-findsimilar.png]]
</div></div>


There is good news and bad news here! The bad: there isn't necessarily an easy way to judge if your bug has already been filed. It takes a little bit of reading and thought. The good news is that scanning this list can help you avoid making a duplicate bug, and keep you informed on related issues.  
There is good news and bad news here! The bad: there isn't necessarily an easy way to judge if your bug has already been filed. It takes a little bit of reading and thought. The good news is that scanning this list can help you avoid making a duplicate bug, and keep you informed on related issues.  
Line 101: Line 114:
For this list of similar issues, you may be able to tell from one of the summaries that your bug has already been reported by someone else. Or, to look deeper into the similar bugs, click on a bug number in the left-hand column, opening it in a new tab. Maybe you can tell that it's the same as the bug you intended to file. If the bug is still open, you can click "Follow bug" in the rightmost column if you want to be emailed when there are updates to the bug.  
For this list of similar issues, you may be able to tell from one of the summaries that your bug has already been reported by someone else. Or, to look deeper into the similar bugs, click on a bug number in the left-hand column, opening it in a new tab. Maybe you can tell that it's the same as the bug you intended to file. If the bug is still open, you can click "Follow bug" in the rightmost column if you want to be emailed when there are updates to the bug.  


[[File:BMO-bugzillahelper2c-following.png]]
<div class="toccolours mw-collapsible mw-collapsed" style="width:auto">
Screenshot
<div class="mw-collapsible-content">
'''[[File:BMO-bugzillahelper2c-following.png]]
</div></div>


If you don't find your bug, you can create a new bug report by clicking "My issue is not listed".  
If you don't find your bug, you can create a new bug report by clicking "My issue is not listed".  
Line 109: Line 126:
Bugzilla Helper gives you three questions to answer.  
Bugzilla Helper gives you three questions to answer.  
* "What did you do?" This helps other people to try to recreate your bug.  
* "What did you do?" This helps other people to try to recreate your bug.  
** For a good understanding of the issue, this section must contain:
*** The OS on which the issue was found (eg. Windows 10x64)
*** The Firefox build (eg. Firefox 58.0.1, or Firefox 60.0a1(2018.01.01), build ID...)
*** All the steps performed in order to reproduce the issue. For example:
**** 1.Launch Firefox.
**** 2. Go to https://www.youtube.com
**** 3. Start a video.
* "What happened?" where you can explain the bad or buggy behavior.  
* "What happened?" where you can explain the bad or buggy behavior.  
** In this section it must be described exactly what happens after steps from ‘What did you do?’ section are followed. For example:
*** The video is not working. Error message is displayed.
* "What should have happened?" where you explain the correct or desired behavior.
* "What should have happened?" where you explain the correct or desired behavior.
** In this sections, is listed exactly what is expected to happen after following the steps from the “What did you do?” section. For example:
*** The video is correctly played.
<div class="toccolours mw-collapsible mw-collapsed" style="width:auto">
Screenshot
<div class="mw-collapsible-content">
'''[[File:Log_a_bug_5.png]]
</div></div>
'''There are a few other options that may apply to your bug.'''
* Attach a file - at this section, a screenshot or a screencast of the actual result can be attached. This will help for a better understanding of the issue.
* Security - this checkbox is expected to be checked only if a security issue is found and it must be hidden from the public.
* Additional Details - this section is available only if selecting ‘Firefox’ product in order so verify that this issue is also reproducible on phone or tablet.
'''Notes'''
* In “Version:” section, the Branch can be selected. For example:
** If the issue is found on Firefox 60.0a1, the “60 Branch” is selected
** If the issue is reproducible on two, or more than two branches, than “Trunk” is selected
* If a crash is encountered, the ID from about:crashes must be pasted in the ‘What happened?’ section
* Is important to add any additional details in the logged bug
* A more detailed description can be found on the [https://wiki.mozilla.org/QA/Bug_Guidelines Bug Guidelines] wiki page
'''Conclusions'''
Writing good, detailed, bug reports may, on one hand, consume time when they are created.
On the other hand, a lot more time would be consumed in the future because of incorrect or incomplete bug reports, when:
* You are required to explain the steps, as the developer is not able to reproduce the issue;
* You have to retry reproducing it, in order to be able to test the fix, after a long time has passed between creating the ticket and solving it;
* The developer, or the entire team, has to investigate and start working on a fix, without being able to get in contact with the reporter;
Writing good bug reports is not a “born with” talent. It’s improved with time, experience and correct attitude.


There are a few other options that may apply to your bug.  In particular, if you believe it is a security issue, check the appropriate box.


Once you're used to filing bugs, you can switch to the [https://bugzilla.mozilla.org/enter_bug.cgi?format=__default__ advanced bug entry form].
Once you're used to filing bugs, you can switch to the [https://bugzilla.mozilla.org/enter_bug.cgi?format=__default__ advanced bug entry form].


There's a detailed guide to making your bug as well formed as possible: the [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines Bug writing guidelines] on MDN.
There's a detailed guide to making your bug as well formed as possible: the [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines Bug writing guidelines] on MDN.
====Many thanks to every contributor for all the hard work!====


==needinfo flag==
==needinfo flag==
747

edits