| | 1 | = The Ticket System = |
| | 2 | |
| | 3 | The issue database provides simple but effective tracking of issues and bugs within a project. |
| | 4 | |
| | 5 | As the central project management element of this system, tickets are used for '''bug reports''', '''feature requests''', '''software support issues''' and '''project tasks'''. |
| | 6 | |
| | 7 | As with the [wiki:SystemWiki wiki], this subsystem has been designed with the goal of making user contribution and participation as simple as possible. It should be as easy as possible to report bugs, ask questions and suggest improvements. |
| | 8 | |
| | 9 | An issue is assigned to a person who must resolve it or reassign the ticket to someone else. |
| | 10 | All tickets can be edited, annotated, assigned, prioritized and discussed at any time. |
| | 11 | |
| | 12 | '''Note:''' To make full use of the ticket system, use it as an ''in bucket'' for ideas and tasks for your project, rather than just bug/fault reporting. |
| | 13 | |
| | 14 | == Ticket Fields == |
| | 15 | |
| | 16 | A ticket contains the following information attributes: |
| | 17 | |
| | 18 | * '''Reporter''' - The author of the ticket. |
| | 19 | * '''Component''' - The project module or subsystem this ticket concerns. |
| | 20 | * '''Version''' - Version of the project that this ticket pertains to. |
| | 21 | * '''Severity''' - What are the effects the issue described? Ranges from an ''enhancement'' request to ''blocker'' (must be fixed before next milestone). |
| | 22 | * '''Priority''' - The importance of is the issue relative to other tasks. |
| | 23 | * '''Milestone''' - When this issue should be resolved at the latest. |
| | 24 | * '''Resolution''' - Reason for why a ticket was closed, such as fixed, invalid, duplicate, etc. |
| | 25 | * '''Keywords''' - Keywords that a ticket is marked with. Useful for searching and report generation. |
| | 26 | * '''Assigned to''' - Principal person responsible for handling the issue. |
| | 27 | * '''Cc''' - A list of other associated people. ''Note: this does '''not''' imply responsibility or any other policy. |
| | 28 | * '''Status''' - What is the current status? |
| | 29 | * '''Summary''' - A brief description summarizing the problem or issue. |
| | 30 | * '''Description''' - The body of the ticket. A good description should be '''specific, descriptive and to the point'''. |
| | 31 | |
| | 32 | == Changing and Commenting Tickets == |
| | 33 | |
| | 34 | Once a ticket has been entered, you can at any time change the |
| | 35 | information by '''annotating''' the bug. This means changes and comments to |
| | 36 | the ticket are logged as a part of the ticket itself. |
| | 37 | |
| | 38 | When viewing a ticket, this log of changes will appear below the main ticket area. |
| | 39 | |
| | 40 | ''In the Trac project, we use ticket comments to discuss issues and |
| | 41 | tasks. This makes understanding the motivation behind a design- or implementation choice easier, when returning to it later.'' |
| | 42 | |
| | 43 | '''Note:''' An important feature is being able to use SystemLinks and |
| | 44 | WikiFormatting in ticket descriptions and comments. Use SystemLinks to refer to |
| | 45 | other issues, changesets or files to make your ticket more specific and easier |
| | 46 | to understand. |
| | 47 | |
| | 48 | '''Note:''' See SytemNotification for how to configure email notifications of ticket changes. |
| | 49 | |
| | 50 | |
| | 51 | See also: SystemGuide, SystemWiki, SystemTicketsCustomFields, SystemNotification |
