| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"> |
| <meta http-equiv="Content-Style-Type" content="text/css" /> |
| <meta name="author" content="Wolfram Garten"> |
| <title>Issue Tracker Guide</title> |
| <style type="text/css"> |
| /* <![CDATA[ */ |
| <!-- |
| @import "/branding/css/tigris.css"; |
| @import "/branding/css/inst.css"; |
| --> |
| /* ]]> */ |
| </style> |
| |
| <link rel="stylesheet" type="text/css" href="/branding/css/print.css" media="print" /> |
| <link rel="shortcut icon" href="http://www.openoffice.org/favicon.ico" /> |
| <script src="/branding/scripts/tigris.js" type="text/javascript"></script> |
| </head> |
| |
| |
| <h1>Issue Tracker Guide</h1> |
| <br> |
| <dd>Here you can find vital information about what to fill in the IssueTracker if you are submitting a new issue, just reading or modifying it. |
| <br><b>Please remember:</b> each piece of information is important for testing and fixing an issue. But make sure it is at the right position.</dd> |
| <br><br> |
| <dd><b>Content:</b></dd> |
| <ul> |
| <li><a href="#enternewissue">Entering a new Issue</a> </li> |
| <li><a href="#issuefields">Issue entry field descriptions</a> </li> |
| <ul> |
| <li><a href="#priorities">Issue priorities</li> |
| <li><a href="#types">Issue types</li> |
| <li><a href="#initialstage">Initial stage</li> |
| <li><a href="#fields">Additional fields</li> |
| <li><a href="#aftercompleting">After completing all necessary fields</li> |
| </ul> |
| <li><a href="#viewandmodify">Viewing and modifying issues</a> </li> |
| </ul> |
| |
| <br> |
| <br> |
| <br> |
| <h2><a id="enternewissue" name="enternewissue">Entering a new issue</a></h2> |
| <ul> |
| <li>Choose the appropriate link to enter a new issue -><a href ="http://qa.openoffice.org/issue_handling/submission_gateway.html"> Issue Tracker.</a></li> |
| <li>Choose the appropriate application, language, project or code module.</li> |
| <li>Selected the appropriate options or input information for each field before using the <i>Submit issue</i> button to enter your issue.</li> |
| </ul> |
| <p>The information you provide here significantly determines the effectiveness of your issue reports and the response to them. Descriptions for each of these fields follow to help you optimize your issue reports.</p> |
| |
| <p><b>Important note:</b>The target is set by the appropriate developer or a member of the QA Team. Setting the target depends upon the impact of the fix, the time needed to do the fixing and the priority of the issue.</p> |
| <br> |
| |
| |
| <h2><a id="issuefields" name="issuefields">Issue entry field descriptions</a></h2> |
| <dl> |
| <a id="version" name="version"></a><b>Found in Version:</b>The release in which you identified this issue or found the defect. |
| <br> |
| <a id="sub" name="sub"></a><b>Component/Subcomponent:</b>Identify area within the project that this issue is associated with. Only one selection is permitted. |
| <br> |
| <a id="platform" name="platform"><b>Platform</b></a> |
| This corresponds to <i>your</i> hardware platform when you are reporting a defect. For example, these options might include: |
| <ul> |
| <li>All (happens on all platform; cross-platform issue)</li> |
| <li>Macintosh</li> |
| <li>PC</li> |
| <li>Sun</li> |
| <li>HP</li> |
| </ul> |
| <b>Note:</b> Selecting the option "All" does not select issues assigned against all platforms. It merely selects issues that <i>occur</i> on all platforms. </dd> |
| <br> |
| <a id="operatingsystem" name="operatingsystem"><b>Operating System:</b></a>This is the operating system against which the issue is being reported. For example, these options might include: |
| <ul> |
| <li>All (happens on all operating systems, making this a cross-platform issue)</li> |
| <li>Windows 95</li> |
| <li>Mac System 8.0</li> |
| <li>Linux</li> |
| |
| </ul> |
| Note that the operating system implies the platform, but not always. For example, Linux can run on PC, Macintosh, and others. </dd> |
| </dl> |
| <br> |
| |
| <h3> <a id="priorities" name="priorities"></a><u>Issue Priorities</u></h3> |
| <dl> |
| <dt><strong>Intention</strong> |
| <dd>The "Priority" field in IssueZilla describes the severity of a problem, for the user base of OpenOffice.org <em>as a whole</em>. If you like, it's a measure of the summed-up annoyance a problem causes. Understood this way, "Priority" is one measure which helps people to plan their work - without additional constraints, a developer would fix a problem the earlier the higher its "Priority" is. <strong>Note</strong>, however, there usually <em>are</em> other constraints and side conditions, which also affect task planning. Such constraints are explicitly not to be described by an issue's "Priority" value.</dd> |
| <br> |
| <dt><strong>Guidelines</strong></dt> |
| <dd>When priorizing an issue, ask yourself the following questions, to judge the severity: |
| <dd> |
| <ul> |
| <li>How much does the problem <em>hinder</em> the user's work?</li> |
| <li><em>How many</em> users would be affected by the problem?</li> |
| |
| <li><em>How often</em> would users be hit by the problem?</li> |
| <li>How easy is it to <em>work around</em> the problem?</li> |
| </ul> |
| <dd>Thinking about those questions should give you a good first estimation on the problems severity for the whole user community (remember that this is what is reflected in the "Priority").</dd> |
| <br> |
| <br> |
| <dt><strong>Definitions</strong></dt> |
| <br><br> |
| <b>P5:</b> |
| <dd>P5 marks problems which describe wrong behavior of the application, but rarely affect anybody noticeably.<br> |
| Issues with this priority are not relevant for a release.<br> |
| Fixing them would be nice-to-have. |
| Example:</dd> |
| <ul> |
| <li>In a seldom-used dialog, a control with an offset of a few pixels<br /></li> |
| </ul> |
| <br> |
| <b>P4:</b> |
| <dd>P4 describes problems which are non-critical or rarely occuring.<br/> |
| Issues with this priority are desired, but not required, to be fixed before the next major release.<br/> |
| |
| Not fixing issues with this priority has a less negative impact than not shipping in time.</dd> |
| <dt>Examples:</dt> |
| <ul> |
| <li> Incorrect behavior that doesn't affect functionality </li> |
| <li> Spelling errors (“Typos”) in rarely seen places</li> |
| |
| <li>Bugs that are easy to workaround</li> |
| <li>Minor performance problems, e.g. a dialog which initially needs 1 second to open, each time you just started the application<br /> |
| </li> |
| </ul> |
| <br> |
| <b>P3:</b> |
| <dd>P3 marks non-trivial problems which probably affect a noticeable number of users.<br/> |
| Issues with this priority must be fixed before the target release.<br/> |
| Not fixing them for the target release must be justified by a superordinate rule.</dd> |
| <dt>Examples:</dt> |
| <ul> |
| <li>Spelling errors in obvious places e.g. an application's main menu</li> |
| <li>Menu entries or standard keyboard shortcuts (e.g. Ctrl-S) do not work</li> |
| <li>Functionality violates its <a target="_blank" href="http://specs.openoffice.org">specification</a></li> |
| |
| <li>The application crashes in very special circumstances;<br> |
| e.g. when you need to customize 129 icons into the same toolbar to make the application crash</li> |
| <li>Responsiveness of a commonly used UI (e.g. the File/Open dialog) is noticeably and consistently bad;<br> |
| e.g. it takes 2 seconds to open every time you invoke it</li> |
| <li>Functionality which is not available, but a workaround exists;<br> |
| e.g. you cannot apply formattings to your text via the toolbar, but only using the menu</li> |
| <li>The user interface for a common functionality is confusing.</li> |
| <li>Noticeable performance regression of a functionality, compared with a previous build / version / release <br /> |
| </li> |
| </ul> |
| <br> |
| <b>P2:</b> |
| <dd>P2 marks severe problems which affect a significant number of customers<br/> |
| Issues with this priority must be fixed before the target release (see <a href="#target_milestone">Target milestone</a>), which usually is the next major release, and should be dealt with as soon as possible.<br/> |
| Not fixing them for the target release is not acceptable.</dd> |
| <dt>Examples:</dt> |
| <ul> |
| <li> An essential product feature - e.g. Printing - does not work at all, and no workaround exists</li> |
| <li>User data is corrupted in an easy-to-encounter way;<br> |
| e.g. saving a document corrupts the resulting file and renders it unusable</li> |
| <li>Crashs or freezes during normal operations of the application</li> |
| <li>A critical usability problem;<br> |
| e.g. a user interface which renders the underlying functionality incomprehensible for the majority of users</li> |
| <li>Severe performance problems in often-used/basic functionality;<br> |
| e.g.</li> |
| <ul> |
| <li>every application startup takes 5 minutes</li> |
| <li>saving/loading of usual small-sized document takes several minutes</li> |
| </ul> |
| <li>Huge memory leaks in common or easy-to-reach functionality;<br> |
| e.g. a mail merge operation which leaks 1 MB per merged document</li> |
| <li>UI responsiveness of a non-essential feature is extremely poor, rendering the feature unusable;<br> |
| e.g. a File/Open dialog which needs 5 minutest to open</li> |
| </ul> |
| <dt><strong><i>Counter-Examples</i></strong></dt> |
| <ul> |
| <li>Functionality is working improperly, but UNDO restores the previous state </li> |
| <br> |
| </ul> |
| <b>P1:</b> |
| <dd>P1 marks extremely severe problems.<br/> |
| Issues with this priority must be fixed immediately, and the fix must be included in the next available build of the application.<br/> |
| Not fixing those issues is simply impossible.</dd> |
| <dt>Examples:</dt> |
| <ul> |
| <li>Reproducible, unavoidable crash or freeze in functionality indispensible for the whole product;<br> |
| e.g. crash upon loading arbitrary documents</li> |
| <li>Build problems</li> |
| <li>Incorrect text or graphics with legal implications </li> |
| <li> Security issue in a released version</li> |
| </ul> |
| <dt><strong><i>Counter-Examples</i></strong></dt> |
| <ul> |
| <li>Nearly everything not listed above. There's rarely <em>anything</em> which really qualifies as P1 issue!<br /> |
| </li> |
| </ul> |
| </div> |
| <br> |
| <a id="types" name="types"><b><u>Issue types</u></b></a> |
| <dd> |
| <p><em><u>Defect:</u></em> is a problem with an existing feature that is either not developed to spec or does not work as designed. These are often referred to as "bugs."</p> |
| <p><em><u>Enhancement:</u></em> is an improvement to an existing feature.</p> |
| <p><em><u>Feature:</u></em> is an addition to the software to add a piece of functionality that does not yet exist.</p> |
| <p><em><u>Task:</u></em> is an activity to be done on behalf or in support of a feature or enhancement. Tasks do not typically require direct changes to the code base.</p> |
| <p><em><u>Patch:</u></em> is a special kind of issue, a section of code to be applied or attached to existing software, often to fix a defect.</p> |
| </dd> |
| <br> |
| |
| <a id="initialstage" name="initialstage"><b><u>Initial state</u></b></a> |
| <br> |
| <dd>If you do not have the permission 'Project Issue Tracking - Change', any issues you enter will have the initial state of "new" or "unconfirmed." Marking an issue unconfirmed means that it is not yet determined whether it is true or valid. Read more about "state" in the <a href="http://qa.openoffice.org/ooQAReloaded/Docs/QA-Reloaded-IssueHandlingOverview.html">"About issues"- page</a>.</dd> |
| <br> |
| <br> |
| |
| <a id="fields" name="fields"> <b><u>Additional fields</u></b></a> |
| <br> |
| <b>Assigned To</b> |
| <dd>Enter the username of the one individual who is in charge of resolving the issue. If this field is left blank, the issue by default is assigned to the component/sub component owner. Every time this field changes, the status changes to <b>NEW</b> to make it visible in the assignee's list of issues.</dd> |
| <br> |
| <dt><b> CC:</b></dt> |
| <dd> |
| Add usernames of other individuals who need notification when this issue changes status or when there is other activity on this issue. Delimit multiple usernames by single spaces only -- no commas or semi-colons are necessary. |
| <p><b>Note:</b> Assign cc addresses sparingly. Project participants whose interest or involvement in this issue is peripheral should be encouraged to use the Issue Tracker to check and track issues rather than to rely on automatic email notification.</p> |
| </dd> |
| <br> |
| <dt><b>URL</b></dt> |
| <br> |
| <dd> |
| How to use this field depends on the issue type: |
| <ul> |
| <li>For defects, URL should lead to a fairly stable system where the the problem is obvious or can be easily reproduced.</li> |
| <li>For enhancements, URL should provide details pertaining to the improvement, such as mockups.</li> |
| <li>For features, URL should link to any web-based form of material explaining the improvement such as mockups or design specs.</li> |
| <li>For tasks, URL is optional and may include linking to the associated feature or enhancement.</li> |
| </ul> |
| </dd> |
| <br> |
| <dt><b>Summary</b></dt> |
| <dd>A terse, specific statement to describe this issue. This should a few unique, self-explanatory words to identify this issue easily in reports and short lists. Limiting your entry to the width of the field is best for the columnar display of query results.</dd> |
| <br> |
| <dt><b>Description</b></dt> |
| <dd>Provide a full description of the issue including any pertinent history or activity around this issue. Because this field is additive, it serves as the knowledge base and means of communicating through this issue's life cycle. Other project participants view and add comments or information using this field.</dd> |
| </dl> |
| <br><br> |
| <a id="aftercompleting" name="aftercompleting"><b><u>After completing all necessary fields:</u></b></a> |
| <br> |
| <p><em><u>Submit</u></em> enters this issue into the project's issue database.</p> |
| <p><em><u>Reset</u></em> returns all field values to their default or blank settings.</p> |
| <p><em><u>Remember values as bookmark template</u></em> lets you save your input settings to save keystrokes when entering multiple issues for the same project component.</p> |
| <p>For more information about entering issues into the Issue Tracker, see also <a href="http://qa.openoffice.org/issue_handling/basic_rules.html">Issue writing guidelines</a>.</p> |
| <br> |
| |
| |
| <h2><a id="viewandmodify" name="viewandmodify">Viewing and modifying issues</a></h2> |
| <p>Existing issues may be accessed in two different ways:</p> |
| <ul> |
| <li>Entering a specific issue number in the "Find" field located on the <strong>Issues</strong> page displays the "Issue View" page.</li> |
| <li>Querying for issues either by clicking the "Query database" button in the Project Issues page displays an "Issue List" page of your results. (See <a href="http://qa.openoffice.org/ooQAReloaded/Docs/QA-Reloaded-ITquery.html">Issue Tracker Query</a>.)</li> |
| </ul> |
| <p>The Issue View page is similar to the Enter issue page and contains many of the same fields, but there are several important additions:</p> |
| <dl> |
| <dt><i>Target Milestone</i></dt> |
| <dd>If your project has designated milestones, this field can be used to associated issues with those milestones, such as version releases. A milestone plan enumerates when different features are expected to be completed. If an issue has a target date or version release, this means the work on this issue must be completed by that date. This field should only be set or changed by the person responsible for the issue.</dd> |
| <dt><i>Add/Remove CC:</i></dt> |
| <dd>You can add additional email addresses to this issue to alert other project members when activity occurs on this issue. If you are adding multiple addresses, delimit these with single spaces; do not use commas or semi-colons. You can also <i>remove</i> one or more email address listed by selecting it and checking the "Remove selected Cc's" box below.</dd> |
| <dt><i>QA Contact</i></dt> |
| <dd>This field should contain an email address or alias for the person(s) responsible for quality control of this issue.</dd> |
| <dt><i>URL</i></dt> |
| <dd>If this field is populated, clicking the field label links directly to the designated URL.</dd> |
| <dt><i>Status whiteboard</i></dt> |
| <dd>The purpose of this generic field can be user-defined and project-specific. This field is used for writing short, one-line notes about the issue.</dd> |
| <dt><i>Attachments</i></dt> |
| <dd> |
| Adding attachment to an issue can be very useful. For defects, appending test cases, screen shots and/or editor logs to the issue can help pinpoint the problem to help the developer reproduce it. |
| <p>For features, enhancements, and tasks, you can attach screen shots, mockups, and other files to provide supplemental information to illustrate the issue.</p> |
| <p>You can also used this field to attach a patch related to the issue when appropriate. Read more about <a href="/nonav/scdocs/contributing_patches.html">contributing patches</a>.</p> |
| </dd> |
| <dt><i>Dependencies</i></dt> |
| <dd>When an issue can't be addressed until one or more other issues are resolved, these are dependencies. Each issue can have other issues it depends upon , as well as issues that depend upon it, that is, other issues that this issue "blocks" while being unresolved.</dd> |
| <dt><a id="vote" name="vote"></a><i>Vote for this issue</i></dt> |
| <dd> |
| <!-- (adapted from bugzilla.mozilla.org's "Bugzilla Voting" page) --> |
| The Issue Tracker's "voting" feature allows project members to have a certain number of votes in their project to use toward issues. Project owners set the number of votes allowed per issue, as well as the number of votes allowed per member. Some projects/components may not allow any, which means you can't vote on those issues at all. Your vote indicates which issues you believe are the most important to be addressed. |
| <p>You may vote for the same bug more than once, however, you have a limited number of total votes allocated to you. You can either vote once for many issues, or use multiple votes for a fewer issues that you think are particularly critical.</p> |
| <p>If an issue has received votes, the total number appears next to "Votes for this issue", or "0" if no votes have been logged. Clicking on this number displays the Show Votes page. If there are votes, names and their associated number of votes are listed.</p> |
| <p>To view a list of issues that have received votes, use the Issue Tracker Query page, and enter the numeral "1" in the "At least ___ votes" field. This returns issues in your query results with at least one vote.</p> |
| <p>To vote for an issue:</p> |
| <ul> |
| <li>Open the issue (by clicking the issue from a list or report).</li> |
| <li>Click on the "Vote for this issue" link just above the "Additional Comments" field. (If no such link appears, then voting may not be allowed for this issue's project/component.)</li> |
| <li>Indicate the number of votes you want to log for this issue. This page also displays how many votes you've given to other bugs, allowing you may reallocate your votes as necessary.</li> |
| <li>You receive automatic email notification anytime changes occur on issues you have voted for.</li> |
| <li>You may review your votes at any time by clicking the "Change your password or preferences" on the <strong>Issues</strong> page or at the bottom of the query page.</li> |
| </ul> |
| <p>What's the purpose of this voting feature? Read about the important role of <a href="http://www.tigris.org/editorial/safetynet.html">consensus voting in open source projects</a>.</p> |
| </dd> |
| <dt><i>Groups</i></dt> |
| <dd>If one or more drop boxes appear identifying project-defined groups to be included in or excluded from viewing an issue, this indicates that the project/component owner has created groups within the project. You should contact this person to determine how to use these fields.</dd> |
| <dt><i>Leave as NEW</i></dt> |
| <dd>If you are viewing an issue with the status NEW but it is not assigned to you, leave this default as checked. When the issue <i>is</i> assigned to you, you should accept it by changing its status to "Started."</dd> |
| <dt><i>Resolve issue</i></dt> |
| <dd>Once an issue is resolved, this is where to designate the type of resolution. Changing an issue to "Resolved" means that as far as the assignee is concerned, this issue is completed. |
| <br><b>Note: Changing an issue's status to FIXED signals all other project members that any source file changes associated with this issue have been checked into the CVS repository.</b></dd> |
| <dt><i>Reassign</i></dt> |
| <dd>The person responsible for the issue can be changed here by entering a new email address, or reassigned to the component/sub component owner.</dd> |
| <dt><i>View Issue Activity</i></dt> |
| <dd>This link displays a snapshot page of changes made to an issue.</dd> |
| <dt><i>Format For Printing</i></dt> |
| <dd>This links redisplays the Issue View in a format for printing out.</dd> |
| <dt><i>Format as XML</i></dt> |
| <dd>This links displays the issue as XML.</dd> |
| <dt><i>Submit</i></dt> |
| <dd> |
| This button saves any modifications made to this issue. <b>Caution! When viewing an issue, the "Enter" key works like the <i>Commit</i> button. Any modifications you may have made (accidentally or otherwise) are saved and the issue's assignee and cc list receive email notification of activity on this issue.</b> |
| <p><em>To exit out of viewing this issue without making any changes</em>, use the links at the top of this page to view other issues, or the <i>Back</i> button in your browser. Even when you have changed fields, as long as you do not use the <i>Submit</i> button or the "Enter" key, the issue remains unchanged in the database.</p> |
| </dd> |
| <dt><i>Reset</i></dt> |
| <dd>Returns all fields to their <i>previously submitted</i> values.</dd> |
| </dl> |
| |
| |
| </div> |
| </div> |
| <div align=right>Reworked by Wolfram Garten</div> |
| </body> |
| </html> |
| |
| |
