[Tutorial] Reporting bugs or suggestions
Posted: Sun Jan 13, 2008 11:26 pm
Why file a report?
2. Check that the bug or suggestion has not been reported yet
Go to the query page : https://bz.apache.org/ooo/ (AOO) or https://bugs.documentfoundation.org/query.cgi (LO)
There are two ways to search for reports. The easiest (but less precise) is to introduce some keywords that identify the problem on the quick search box. The other is to click on the big Search button or the Search link on top left of the page: you'll see two search options center, at the top of the page, a Simple Search and an Advanced Search:
3. Here we are, let's file it
First, you need an Apache BugZilla (BZ, from now on) account: As the user database is different from the forum, you need to register. If your forum username has not been used by someone else in BugZilla, you can have the same login/password. Now, click on New Account.
Select the appropriate Product, like Writer, Calc, etc. Each product has a small description that will help you which one to chose.
For a problem affecting all the applications, select "General".
On the following page, select the Component that shows the problem. For example, if the problem is during the edition select "editing" or if the problem appears when importing and external format (like .doc) select "open-import": on the box called "Component description" you'll see a brief description that will help you to choose the right component.
Select the Version on which you can see the problem. Versions are listed alphabetically, so it is possible you'll need to scroll through the list. For example, version 3.4.0 of AOO is identified with AOO340, while version 3.4.1 is identified with AOO341.
Under Severity select how bad you think the problem is. You have several options, from the worst ("critical" and "blocker") to the minor ones ("trivial")
[*]Consider the possibility to attach sample files (documents, screen-shots...) with Add an attachment button[/*]
[*]Review the provided information and when ready, click on Submit Bug.[/*]
[/list]
4. Vote for it!
Each account can cast votes to issues. You're granted 5 votes per component and you can cast 1 or 2 votes for a single issue.
Click the link to the vote page on your issue, fill the related field and click the Submit button bottom of page to confirm your vote.
Note that when an issue has been fixed, you need to clear your votes from that issue: go to the My votes page, set 0 instead of the votes number and submit. Fixed issues are marked with strikethrough characters.
5. Make the others vote for it!
You've created a thread here ? Post the link to your issue inside, so that other users could jump to it quickly and vote for it also if they're interested.
Use the BBCode URL for that: [ url=address_to_bug_report ]Issue # - Summary[ /url ] (spaces added in tags here to avoid the automatic recognition).
Advertise your issue: put the tag '[Issue]' at the beginning of your first post title in your thread.
- You like OpenOffice, you want to improve it? Help the developers by pointing them the flaws you could have seen
- Reports are also used to ask for new features (RFE = Request For Enhancement)
- You should use the latest version available because your bug may have been fixed in the meantime. Note that #.#.1 versions are for bug fixes only so if one of these versions is available, upgrade.
- Creating a thread here can help determine if the issue is linked to your system (or a specific file) only. Moreover, you'll have plenty of additional information: sometimes, a bug is specific to an OS or a distribution (for Linux).
- For Linux distributions, try to check if the bug doesn't come from your distribution packaging.
2. Check that the bug or suggestion has not been reported yet
Go to the query page : https://bz.apache.org/ooo/ (AOO) or https://bugs.documentfoundation.org/query.cgi (LO)
There are two ways to search for reports. The easiest (but less precise) is to introduce some keywords that identify the problem on the quick search box. The other is to click on the big Search button or the Search link on top left of the page: you'll see two search options center, at the top of the page, a Simple Search and an Advanced Search:
- Simple Search, compared with "Quick search" gives you the possibility to select the Product: Writer, Calc, etc.
NB: for a problem affecting all the applications, select "General". - Advanced Search gives you the possibility to also select:
- Product, Component, Status & Resolution: really for advanced searches! for closed bugs for example.
- Detailed Issue Information: Version, Severity, Priority, Hardware, OS & Target Milestone
- Search By People: if you know the Bug Assignee or Reporter especially
- Custom Search: really advanced search
3. Here we are, let's file it
First, you need an Apache BugZilla (BZ, from now on) account: As the user database is different from the forum, you need to register. If your forum username has not been used by someone else in BugZilla, you can have the same login/password. Now, click on New Account.
- IMPORTANT: The email address you use to register will be your user name on the system and will be visible for all registered users. If you want to maintain your principal email address private, create an account on one of the many free webmail services available on internet, like gmail, yahoo, etc. Don't use your private email to register on BZ.
Select the appropriate Product, like Writer, Calc, etc. Each product has a small description that will help you which one to chose.
For a problem affecting all the applications, select "General".
On the following page, select the Component that shows the problem. For example, if the problem is during the edition select "editing" or if the problem appears when importing and external format (like .doc) select "open-import": on the box called "Component description" you'll see a brief description that will help you to choose the right component.
Select the Version on which you can see the problem. Versions are listed alphabetically, so it is possible you'll need to scroll through the list. For example, version 3.4.0 of AOO is identified with AOO340, while version 3.4.1 is identified with AOO341.
Under Severity select how bad you think the problem is. You have several options, from the worst ("critical" and "blocker") to the minor ones ("trivial")
- blocker: use this option only for the errors that produce data loss, hangs or problems that prevent the program start
- critical: the application is not usable or crashes
- major: important feature broken
- normal: random hangs, menus that do not work on the advertised way... no data loss.
- minor: something wrong that could be confusing at first but with no feature loss (wrong translation for example)
- trivial: a typo in the help file for example
- Write the Summary field as concise and precise as you can (this is the report title that will be shown near the bug reference when you perform a search). [list]NOTE: When writing the "Summary", the system will automatically search reports with a simmilar summary: if on the resulting list a relevant report is shown well, you don't need to go on... ;) just comment on that issue and vote for it.
[*]Consider the possibility to attach sample files (documents, screen-shots...) with Add an attachment button[/*]
[*]Review the provided information and when ready, click on Submit Bug.[/*]
[/list]
- IMPORTANT:
- When you complete the form not all the available field will be available unless you select "Show Advanced Fields", option that, perhaps, offers too many fields... an important field not shown on the default form template is "Issue Type", used to determine the kind of the report (error, enhancement request...). Unless you select "Show Advanced Fields" this field will be available only after you send the report. The possible values for this field are.
- DEFECT
ENHANCEMENT
FEATURE
TASK
PATCH
- DEFECT
- When you complete the form not all the available field will be available unless you select "Show Advanced Fields", option that, perhaps, offers too many fields... an important field not shown on the default form template is "Issue Type", used to determine the kind of the report (error, enhancement request...). Unless you select "Show Advanced Fields" this field will be available only after you send the report. The possible values for this field are.
4. Vote for it!
Each account can cast votes to issues. You're granted 5 votes per component and you can cast 1 or 2 votes for a single issue.
Click the link to the vote page on your issue, fill the related field and click the Submit button bottom of page to confirm your vote.
Note that when an issue has been fixed, you need to clear your votes from that issue: go to the My votes page, set 0 instead of the votes number and submit. Fixed issues are marked with strikethrough characters.
5. Make the others vote for it!
You've created a thread here ? Post the link to your issue inside, so that other users could jump to it quickly and vote for it also if they're interested.
Use the BBCode URL for that: [ url=address_to_bug_report ]Issue # - Summary[ /url ] (spaces added in tags here to avoid the automatic recognition).
Advertise your issue: put the tag '[Issue]' at the beginning of your first post title in your thread.