Hey! I'm Woody! Howdy, Howdy, Howdy! |
This section contains information for end-users of Bugzilla. If you are administering a Bugzilla installation, please consult the Installing and Administering Bugzilla portions of this Guide.
There is a Bugzilla test installation, called Landfill, which you are welcome to play with. However, it does not necessarily have all Bugzilla features enabled, and often runs cutting-edge versions of Bugzilla for testing, so some things may work slightly differently than mentioned here.
If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of Bugzilla for the URL you should use to access it. If you're test-driving Bugzilla, use this URL: http://landfill.tequilarista.org/bugzilla-tip/
Click the "Open a new Bugzilla account" link, enter your email address and, optionally, your name in the spaces provided, then click "Create Account".
Within moments, you should receive an email to the address you provided above, which contains your login name (generally the same as the email address), and a password you can use to access your account. This password is randomly generated, and can be changed to something more memorable.
Click the "Log In" link in the yellow area at the bottom of the page in your browser, enter your email address and password into the spaces provided, and click "Login".
You are now logged in. Bugzilla uses cookies for authentication, so (unless your IP address changes) you should not have to log in again.
The core of Bugzilla is the screen which displays a particular bug. It's a good place to explain some Bugzilla concepts. Bug 1 on Landfill is a good example. Note that the names of most fields are hyperlinks; clicking them will take you to context-sensitive help on that particular field.
Product and Component: Bugs are divided up by Product and Component, with a Product having one or more Components in it. For example, bugzilla.mozilla.org's "Bugzilla" Product is composed of several Components:
| Administration, Administration of a bugzilla installation, including editcomponents.cgi, editgroups.cgi, editkeywords.cgi, editparams.cgi, editproducts.cgi, editusers.cgi, editversions.cgi, and sanitycheck.cgi. |
| Bugzilla-General, Anything that doesn't fit in the other components, or spans multiple components. |
| Creating/Changing Bugs, Creating, changing, and viewing bugs. enter_bug.cgi, post_bug.cgi, show_bug.cgi and process_bug.cgi. |
| Documentation, The bugzilla documentation, including anything in the docs/ directory and The Bugzilla Guide |
| Email, Anything to do with email sent by Bugzilla. processmail |
| Installation, The installation process of Bugzilla. This includes checksetup.pl and whatever else it evolves into. |
| Query/Buglist, Anything to do with searching for bugs and viewing the buglists. query.cgi and buglist.cgi |
| Reporting/Charting, Getting reports from Bugzilla. reports.cgi and duplicates.cgi |
| User Accounts, Anything about managing a user account from the user's perspective. userprefs.cgi, saved queries, creating accounts, changing passwords, logging in, etc. |
| User Interface, General issues having to do with the user interface cosmetics (not functionality) including cosmetic issues, HTML templates, etc. |
Status and Resolution: A bug passes through several Statuses in its lifetime, and ends up in the RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.) The different possible values for Status and Resolution on your installation will be documented in the context-sensitive help for those items.
Assigned To: The person responsible for fixing the bug.
URL: A URL associated with the bug, if any.
Summary: A one-sentence summary of the problem.
Status Whiteboard: (a.k.a. Whiteboard) A free-form text area for adding short notes and tags to a bug.
Keywords: The administrator can define keywords which you can use to tag and categorise bugs - e.g. The Mozilla Project has keywords like crash and regression.
Platform and OS: These indicate the computing environment where the bug was found.
Version: The "Version" field is usually used for versions of a product which have been released, and is set to indicate which versions of a Component have the particular problem the bug report is about.
Priority: The bug assignee uses this field to prioritise his or her bugs. It's a good idea not to change this on other people's bugs.
Severity: This indicates how severe the problem is - from blocker ("application unusable") to trivial ("minor cosmetic issue"). You can also use this field to indicate whether a bug is an enhancement request.
Target: (a.k.a. Target Milestone) A future version by which the bug is to be fixed. e.g. The Bugzilla Project's milestones for future Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not restricted to numbers, thought - you can use any text strings, such as dates.
Reporter: The person who filed the bug.
CC list: A list of people who get mail when the bug changes.
Attachments: You can attach files (e.g. testcases or patches) to bugs. If there are any attachments, they are listed in this section.
Dependencies: If this bug cannot be fixed unless other bugs are fixed (depends on), or this bug stops other bugs being fixed (blocks), their numbers are recorded here.
Votes: Whether this bug has any votes.
Additional Comments: You can add your two cents to the bug discussion here, if you have something worthwhile to say.
The Bugzilla Search page is is the interface where you can find any bug report, comment, or patch currently in the Bugzilla system. You can play with it here: landfill.tequilarista.org/bugzilla-tip/query.cgi.
The Search page has controls for selecting different possible values for all of the fields in a bug, as described above. Once you've defined a search, you can either run it, or save it as a Remembered Query, which can optionally appear in the footer of your pages.
Highly advanced querying is done using Boolean Charts, which have their own context-sensitive help.
If you run a search, a list of matching bugs will be returned. The default search is to return all open bugs on the system - don't try running this search on a Bugzilla installation with a lot of bugs!
The format of the list is configurable. For example, it can be sorted by clicking the column headings. Other useful features can be accessed using the links at the bottom of the list:
| Long Format: this gives you a large page with a non-editable summary of the fields of each bug. |
| Change Columns: change the bug attributes which appear in the list. |
| Change several bugs at once: If your account is sufficiently empowered, you can make the same change to all the bugs in the list - for example, changing their owner. |
| Send mail to bug owners: Sends mail to the owners of all bugs on the list. |
| Edit this query: If you didn't get exactly the results you were looking for, you can return to the Query page through this link and make small revisions to the query you just made so you get more accurate results. |
And all this time, I thought we were taking bugs out... |
Years of bug writing experience has been distilled for your reading pleasure into the Bug Writing Guidelines. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.
The procedure for filing a test bug is as follows:
Go to Landfill in your browser and click Enter a new bug report.
Select a product - any one will do.
Fill in the fields. Bugzilla should have made reasonable guesses, based upon your browser, for the "Platform" and "OS" drop-down boxes. If they are wrong, change them.
Select "Commit" and send in your bug report.