Documentation/OpenOffice.org needs YOU
<title>OpenOffice.org Needs YOU!</title> </head> <body>
|The following text is an edited copy of a text by Dan Kegel.
You can find the original text with more information for developers at Kegels web site.
- 1 <a name="top">OpenOffice.org Needs YOU!</a>
- 1.1 <a name="contents">Contents</a>
- 1.2 <a name="intro">Introduction</a>
- 1.3 <a name="intro.backlog">The Problem Report Backlog</a>
- 1.4 <a name="intro.triage">Triage</a>
- 1.5 <a name="howtohelp">How to help</a>
- 1.6 <a name="workflow">Workflow</a>
- 1.7 <a name="priorities">Priorities, Priorities</a>
<a name="top">OpenOffice.org Needs YOU!</a>
- <a href="#intro">Introduction</a>
- <a href="#intro.backlog">The Problem Report Backlog</a>
- <a href="#intro.triage">Triage</a>
- <a href="#howtohelp">How to help</a>
- <a href="#workflow">Workflow</a>
- <a href="#priorities">Priorities, Priorities</a>
- <a href="#query.mybugs">Bugs you've already commented on, but which are still open</a>
- <a href="#query.recent">Recently Reported Bugs</a>
- <a href="#query.compat">Microsoft Office Compatibility Bugs</a>
- <a href="#query.crash">Crash Bugs</a>
- <a href="#query.votes">Bugs with Votes</a>
- <a href="#query.versions">Bugs reported against particular versions</a>
- <a href="#dump">Capturing Stack Dumps</a>
- <a href="#valgrind">Running OpenOffice with Valgrind</a>
- Link: <a href="ooo111.html">OpenOffice 1.1.1 Changes</a>
- Link: <a href="q.html">OpenOffice 2.0 Issue Overview</a>
- <a href="#links">Other Links</a>
<a href="http://www.openoffice.org/">OpenOffice.org</a> is a free, Microsoft Office-compatible office suite which is becoming increasingly popular. Individuals, schools, governments, and companies are evaluating OpenOffice.org as an effective and inexpensive alternative to Microsoft Office.
I recently tested compatibility between OpenOffice.org and Microsoft Office by checking whether OpenOffice could correctly display Microsoft Office documents. My unscientific impression is that Version 1.0.3 of OpenOffice.org scores about a 70 out of 100 on MS Office compatibility, and Version 1.1.0 scores about a 90. The new version is so good that many people won't notice any problems when exchanging documents with MS Office users. <p> However -- if you *do* notice problems, you face a choice. You could:
- do nothing, and wait for someone else to notice and fix the problems,
- file bug reports for the problems you see, or
- file bug reports for problems you see, and help the team sort through bug reports filed by others
The more you help, the more likely the problems you care about will be solved in the next release. I personally have helped sort through a number of bug reports, and have been very happy to discover that my efforts made a big difference - the <a href="http://www.openoffice.org/project/www/issues/show_bug.cgi?id=14053">crash bugs I sent on to the developers</a> are getting fixed rapidly. <p> This page assumes you're already familiar with filing bug reports, and tries to show you how to help sort through other people's bug reports effectively.
<a name="intro.backlog">The Problem Report Backlog</a>
OpenOffice.org is good software, but like all software, it has imperfections. Lately, so many people are using the OpenOffice.org office suite that they're actually running into even fairly hard-to-trigger problems. Many of these users are helpfully filing problem reports in IssueZilla, and the OpenOffice.org developers are working on resolving the issues as they press on towards the release of version 1.1.1. <p> Problem is, problem reports are coming in faster than they can be dealt with, because many of the problem reports are duplicates or system problems. The result is a backlog of over a thousand unexamined problem reports from users, and every day, another four new reports are added to the backlog. This backlog is both a shame, and a treasure trove. Many of the problem reports in the backlog contain enough information for developers to quickly find and solve the problem - but it takes time to sort through the reports. <p> That's where you come in. You can help the developers do what they do best. All you have to do is help sort through the incoming bug reports. This is called triage.
Triage is what medics do when wounded soldiers arrive at a field hospital so fast they can't all be helped. They decide one of three things about each arriving patient, namely: he/she is either
- well enough that they don't really need a doctor,
- sick, and could get better if they get to see a doctor, or
- need last rites more than they need the doctor.
Similarly, triage is also what QA people do when bug reports come in too fast for developers to handle by themselves. They look at each incoming bug report, and decide whether it:
- is a duplicate of a known bug, in which case they can often email a workaround to the user,
- is a bug in some other piece of software, in which case they try to direct the user to the right place for support for that software, or
- is a reproducible and novel bug, in which case they send a recipe for reproducing the bug to the developers.
That lets the developers focus on fixing problems in the code.
<a name="howtohelp">How to help</a>
Here's how to get started:
- <a href="http://www.openoffice.org/servlets/Join">Register as a member of OpenOffice.org</a>
- Request to be a member of the QA project by clicking the "Join This Project" link at the upper right hand of <a href="http://qa.openoffice.org/">qa.openoffice.org</a>
- Review <a href="http://qa.openoffice.org/helping.html">qa.openoffice.org/helping.html</a> and <a href="http://qa.openoffice.org/priorities.html">qa.openoffice.org/priorities.html</a>
- <a href="http://qa.openoffice.org/servlets/ProjectMailingListList">Join the firstname.lastname@example.org mailing list</a>
- Request the ability to set issue status by emailing email@example.com with subject line "Volunteer Privileges - <OOo.org userid>". Mention your OOo.org userid again in the message body, and while you're at it, introduce yourself to the group - it's nice to know who we're working with. After your request is granted, you should be able to add the oooqa keyword and modify all fields in an issue.
Then pick an <a href= "http://www.openoffice.org/project/www/issues/buglist.cgi?issue_type=DEFECT&issue_status=UNCONFIRMED&changedin=5&keywords=oooqa&keywords_type=nowords&order=%27Importance%27"> unconfirmed bug report</a> (or issue, as the OpenOffice team calls them), and help triage it as follows:
- See if you can find a similar bug in the list of <a href= "dups.html">frequently-duplicated issues</a> or by <a href= "http://www.openoffice.org/project/www/issues/query.cgi">searching Issuezilla</a>. If you think it's a duplicate of issue 12345, say something like "Looks like a duplicate of issue 12345" in the Comment box. The word 'issue' followed by a number gets turned into a handy hyperlink, so people who look at the bug report can click on those words to see how issue 12345 was solved.
- Try to reproduce the bug on your computer. In the Comment box, say whether you were able to or not, and how you did it (if you weren't following a recipe already in the bug report). If you can't reproduce the bug, also ask for more details if there wasn't enough info in the original report.
- If it's a crash or freeze bug, try to get a <a href= "#dump">stack dump</a> and attach it to the bug report.
- If you *can* reproduce the bug, mark it 'NEW' to signal the developers to have a look.
- If you can't reproduce the bug, and you're pretty sure you have all the info you need, mark the bug WORKSFORME.
- If you want to get email when someone replies (and you probably do), put your @openoffice.org email address (the one given to you when you registered to use Issuezilla) in the CC: field in the upper right.
- Add the keyword 'oooqa' to show someone's started triaging it.
- Then press the Submit button.
That's all there is to it!
If you asked for more information from the original submitter, and you remembered to put your OpenOffice.org email address in the CC: field in the upper right, you'll get email when they reply to your question. When you get the reply, go to the bug's page in IssueZilla, and finish triaging the bug if you can. (If you forgot to add your email address, you can still <a href="#query.mybugs">check for replies; see below.</a>)
A helpful diagram of the life cycle of a bug report is online at <a href="http://qa.openoffice.org/issue_handling/workflowcharts/taskhandling_workflow_issuetracker_confirm.html">qa.openoffice.org/issue_handling/taskhandling_workflow_issuetracker_confirm.html</a>.
<a name="priorities">Priorities, Priorities</a>
There are so many bug reports that it's vital to tackle the ones with the highest potential payoff first. This is a matter of taste. Some people might want to look just at fresh bugs, others might care more about crash bugs, others might care more about Microsoft Office compatibility.
No matter what area you care about, you can probably come up with an IssueZilla query that pulls up bug reports about it. Below are a few example queries, enough for you to get started with. <p> Note: these example queries aren't perfect - they miss a few bugs, and pull up a few issues that aren't really what they were meant to find, so take them with a grain of salt. You can edit the queries by clicking on the "Edit Query" link on the bottom right of the query result page.
<a name="query.mybugs">Bugs you've already commented on, but which are still open</a>
If you've already started triaging some bugs, you should periodically check on their status to make sure they don't fall through the cracks. Easiest way to do that is to enter your @OpenOffice.org email address in this box and press ENTER: <form method=get action="http://www.openoffice.org/project/www/issues/buglist.cgi"> <input TYPE="hidden" NAME="issue_type" VALUE="DEFECT"> <input TYPE="hidden" NAME="issue_status" VALUE="UNCONFIRMED"> <input TYPE="hidden" NAME="emailassigned_to1" VALUE="1"> <input TYPE="hidden" NAME="emaillongdesc1" VALUE="1"> <input TYPE="hidden" NAME="emailtype1" VALUE="substring"> <input TYPE="hidden" NAME="order" VALUE="Issue Number"> <input NAME="email1" VALUE="@openoffice.org"> <input TYPE="submit" VALUE="Submit query">
<a name="query.recent">Recently Reported Bugs</a>
Recently reported bugs are important to check because a user is waiting for help, and is probably willing to provide additional information or testcases if you need them to reproduce the bug. <p>You can find a daily list of recently reported bugs, plus excerpts from developer blogs, at http://planet.go-oo.org/