|
39
|
1 = The Trac Ticket System =
|
|
|
2 [[TracGuideToc]]
|
|
|
3
|
|
|
4 The Trac issue database provides simple but effective tracking of issues and bugs within a project.
|
|
|
5
|
|
|
6 As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.
|
|
|
7
|
|
|
8 As with the TracWiki, 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.
|
|
|
9
|
|
|
10 An issue is assigned to a person who must resolve it or reassign the ticket to someone else.
|
|
|
11 All tickets can be edited, annotated, assigned, prioritized and discussed at any time.
|
|
|
12
|
|
|
13 '''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.
|
|
|
14
|
|
|
15 == Ticket Fields ==
|
|
|
16
|
|
|
17 A ticket contains the following information attributes:
|
|
|
18
|
|
|
19 * '''Reporter''' - The author of the ticket.
|
|
|
20 * '''Type''' - The nature of the ticket (for example, defect or enhancement request)
|
|
|
21
|
|
|
22 * '''Component''' - The project module or subsystem this ticket concerns.
|
|
|
23 * '''Version''' - Version of the project that this ticket pertains to.
|
|
|
24 * '''Keywords''' - Keywords that a ticket is marked with. Useful for searching and report generation.
|
|
|
25
|
|
|
26 * '''Priority''' - The importance of this issue, ranging from ''trivial'' to ''blocker''.
|
|
|
27 * '''Milestone''' - When this issue should be resolved at the latest.
|
|
|
28 * '''Assigned to/Owner''' - Principal person responsible for handling the issue.
|
|
|
29 * '''Cc''' - A list of other associated people. ''Note that this does not imply responsiblity or any other policy.''
|
|
|
30
|
|
|
31 * '''Resolution''' - Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}.
|
|
|
32 * '''Status''' - What is the current status? One of {{{new}}}, {{{assigned}}}, {{{closed}}}, {{{reopened}}}.
|
|
|
33 * '''Summary''' - A brief description summarizing the problem or issue.
|
|
|
34 * '''Description''' - The body of the ticket. A good description should be specific, descriptive and to the point.
|
|
|
35
|
|
|
36 '''Note:''' Versions of Trac prior to 0.9 did not have the ''type'' field, but instead provided a ''severity'' field and different default values for the ''priority'' field. This change was done to simplify the ticket model by removing the somewhat blurry distinction between ''priority'' and ''severity''. However, the old model is still available if you prefer it: just add/modify the default values of the ''priority'' and ''severity'', and optionally hide the ''type'' field by removing all the possible values through [wiki:TracAdmin trac-admin].
|
|
|
37
|
|
|
38
|
|
|
39 == Changing and Commenting Tickets ==
|
|
|
40
|
|
|
41 Once a ticket has been entered into Trac, you can at any time change the
|
|
|
42 information by '''annotating''' the bug. This means changes and comments to
|
|
|
43 the ticket are logged as a part of the ticket itself.
|
|
|
44
|
|
|
45 When viewing a ticket, the history of changes will appear below the main ticket area.
|
|
|
46
|
|
|
47 ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes
|
|
|
48 understanding the motivation behind a design- or implementation choice easier,
|
|
|
49 when returning to it later.''
|
|
|
50
|
|
|
51 '''Note:''' An important feature is being able to use TracLinks and
|
|
|
52 WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
|
|
|
53 other issues, changesets or files to make your ticket more specific and easier
|
|
|
54 to understand.
|
|
|
55
|
|
|
56 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.
|
|
|
57
|
|
|
58 === State Diagram ===
|
|
|
59 http://projects.edgewall.com/trac/attachment/wiki/TracTickets/Trac%20Ticket%20State%20Chart%2020040607DF.png?format=raw
|
|
|
60
|
|
|
61
|
|
|
62 == Default Values for Drop-Down Fields ==
|
|
|
63
|
|
|
64 The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section:
|
|
|
65
|
|
|
66 * `default_type`: Default ticket type
|
|
|
67 * `default_component`: Name of the component selected by default
|
|
|
68 * `default_version`: Name of the default version
|
|
|
69 * `default_milestone`: Name of the default milestone
|
|
|
70 * `default_priority`: Default priority value
|
|
|
71 * `default_severity`: Default severity value
|
|
|
72
|
|
|
73 If any of these options are omitted, the default value will either be the first in the list, or an empty value, depending on whether the field in question is required to be set.
|
|
|
74
|
|
|
75
|
|
|
76 == Hiding Fields and Adding Custom Fields ==
|
|
|
77
|
|
|
78 Many of the default ticket fields can be hidden from the ticket web interface simply by removing all the possible values through [wiki:TracAdmin trac-admin]. This of course only applies to drop-down fields, such as ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''.
|
|
|
79
|
|
|
80 Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information.
|
|
|
81
|
|
|
82
|
|
|
83 == Assign-to as Drop-Down List ==
|
|
|
84
|
|
|
85 If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the `restrict_owner` option of the `[ticket]` section in [wiki:TracIni trac.ini] to “true”. In that case, Trac will use the list of all users who have logged in and set their email address to populate the drop-down field.
|
|
|
86
|
|
|
87 ''Note that this feature is '''still experimental as of version 0.9'''. There is no way to only display a subset of all known users as possible ticket owners. Nor is there a convenient way to remove emeritus users short of directly modifying the database.''
|
|
|
88
|
|
|
89
|
|
|
90 == Preset Values for New Tickets ==
|
|
|
91
|
|
|
92 To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with variable=value separated by &.
|
|
|
93
|
|
|
94 Possible variables are :
|
|
|
95
|
|
|
96 * '''reporter''' - Name or email of the reporter
|
|
|
97 * '''summary''' - Summary line for the ticket
|
|
|
98 * '''description''' - Long description of the ticket
|
|
|
99 * '''component''' - The component droplist
|
|
|
100 * '''version''' - The version droplist
|
|
|
101 * '''severity''' - The severity droplist
|
|
|
102 * '''keywords''' - The keywords
|
|
|
103 * '''priority''' - The priority droplist
|
|
|
104 * '''milestone''' - The milestone droplist
|
|
|
105 * '''owner''' - The person responsible for the ticket
|
|
|
106 * '''cc''' - The list of emails for notifying about the ticket change
|
|
|
107
|
|
|
108 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''
|
|
|
109
|
|
|
110
|
|
|
111 See also: TracGuide, TracWiki, TracTicketsCustomFields, TracNotification |
