Changes between Version 2 and Version 3 of TracTickets


Ignore:
Timestamp:
Jun 6, 2013, 4:39:51 AM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTickets

    v2 v3  
    22[[TracGuideToc]]
    33
    4 The Trac issue database provides simple but effective tracking of issues and bugs within a project.
     4The Trac ticket database provides simple but effective tracking of issues and bugs within a project.
    55
    6 As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.
     6As the central project management element of Trac, tickets can be used for '''project tasks''', '''feature requests''', '''bug reports''', '''software support issues''' among others.
    77
    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.
     8As 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, suggest improvements and discuss resolutions.
    99
    1010An issue is assigned to a person who must resolve it or reassign the ticket to someone else.
    1111All tickets can be edited, annotated, assigned, prioritized and discussed at any time.
    1212
    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.
     13[=#edit-permissions]
     14However, some Trac installations may put restrictions in place about who can change what. For example, the default installation doesn't permit to non-authenticated users ("anonymous" users) to change anything, even to comment on an issue, for obvious spam prevention reasons. Check the local contributing policy, which you can usually find on the front page WikiStart, or contact your local Trac administrator.
    1415
    1516== Ticket Fields ==
     
    1718A  ticket contains the following information attributes:
    1819 
    19  * '''Reporter''' - The author of the ticket.
    20  * '''Type''' - The nature of the ticket (for example, defect or enhancement request)
     20 * '''Reporter''' — The author of the ticket.
     21 * '''Type''' — The nature of the ticket (for example, defect or enhancement request). See TicketTypes for more details.
     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 * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''. A pull-down if different priorities where defined.
     26 * '''Milestone''' — When this issue should be resolved at the latest. A pull-down menu containing a list of milestones.
     27 * '''Assigned to/Owner''' — Principal person responsible for handling the issue.
     28 * '''Cc''' — A comma-separated list of other users or E-Mail addresses to notify. ''Note that this does not imply responsiblity or any other policy.''
     29 * '''Resolution''' — Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}.
     30 * '''Status''' — What is the current status? One of {{{new}}}, {{{assigned}}}, {{{closed}}}, {{{reopened}}}.
     31 * '''Summary''' — A brief description summarizing the problem or issue. Simple text without WikiFormatting.
     32 * '''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point. Accepts WikiFormatting.
    2133
    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.
     34'''Notes:'''
     35 - 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].
    2536
    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.
     37 - the [trac:TicketTypes type], [trac:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or with the [trac:WebAdmin WebAdmin] plugin.
    3538
    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 
     39 - Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes]
    3840
    3941== Changing and Commenting Tickets ==
    4042
    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.
     43With appropriate permissions, as already mentioned [#edit-permissions above], a ticket entered into Trac can at any time be modified by '''annotating'''.
    4444
    45 When viewing a ticket, the history of changes will appear below the main ticket area.
     45Then, annotations like changes and comments to the ticket are logged as a part of the ticket itself. When viewing a ticket, the history of changes will appear below the main ticket area.
    4646
    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.''
     47Comment editing (available since 0.12) is meant to be used to make small corrections to comments, like fixing formatting, forgotten WikiFormatting or spelling errors, not major edits. For longer edits, you should be adding a new comment instead. Editing a comment will not produce a new entry on [/timeline] while entering a new comment or other changes will do.
    5048
    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.
     49All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket.
    5550
    56 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.
    5751
    58 === State Diagram ===
    59 http://projects.edgewall.com/trac/attachment/wiki/TracTickets/Trac%20Ticket%20State%20Chart%2020040607DF.png?format=raw
     52'''Notes:'''
     53 - An important feature is being able to use TracLinks and WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to other issues, changesets or files to make your ticket more specific and easier to understand.
    6054
     55 - See TracNotification for how to configure email notifications of ticket changes.
     56
     57 - See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.
    6158
    6259== Default Values for Drop-Down Fields ==
     
    6461The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section:
    6562
    66  * `default_type`: Default ticket type
    6763 * `default_component`: Name of the component selected by default
    68  * `default_version`: Name of the default version
    6964 * `default_milestone`: Name of the default milestone
    7065 * `default_priority`: Default priority value
    7166 * `default_severity`: Default severity value
     67 * `default_type`: Default ticket type
     68 * `default_version`: Name of the default version
     69 * `default_owner`: Name of the default owner. If set to the text "< default >" (the default value), the component owner is used.
    7270
    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.
     71If 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.  Some of these can be chosen through the [trac:WebAdmin WebAdmin] plugin in the "Ticket System" section (others in the [[wiki:TracIni#ticket-section|"[ticket]"]] section in `trac.ini`).
    7472
    7573
     
    8381== Assign-to as Drop-Down List ==
    8482
    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.
     83If 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 accessed the project to populate the drop-down field.
    8684
    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.''
     85To appear in the dropdown list, a user needs be registered with the project, ''i.e.'' a user session should exist in the database. Such an entry is automatically created in the database the first time the user submits a change in the project, for example when editing the user's details in the ''Settings'' page, or simply by authenticating if the user has a login. Also, the user must have `TICKET_MODIFY` [TracPermissions permissions].
    8886
     87'''Notes:'''
     88 - See [http://pacopablo.com/wiki/pacopablo/blog/set-assign-to-drop-down Populating Assign To Drop Down] on how to add user entries at database level
     89
     90 - If you need serious flexibility and aren't afraid of a little plugin coding of your own, see [http://trac-hacks.org/wiki/FlexibleAssignToPlugin FlexibleAssignTo] (disclosure: I'm the author)
     91
     92 -  Activating this option may cause some performance degradation, read more about this in the [trac:TracPerformance#Configuration Trac performance] page.
    8993
    9094== Preset Values for New Tickets ==
    9195
    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 &.
     96To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with `variable=value` separated by `&`.
    9397
    9498Possible variables are :
    9599
    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
     100 * '''type''' — The type droplist
     101 * '''reporter''' — Name or email of the reporter
     102 * '''summary''' — Summary line for the ticket
     103 * '''description''' — Long description of the ticket
     104 * '''component''' — The component droplist
     105 * '''version''' — The version droplist
     106 * '''severity''' — The severity droplist
     107 * '''keywords''' — The keywords
     108 * '''priority''' — The priority droplist
     109 * '''milestone''' — The milestone droplist
     110 * '''owner''' — The person responsible for the ticket
     111 * '''cc''' — The list of emails for notifying about the ticket change
    107112
    108 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''
     113Example: ''`[/newticket?summary=Compile%20Error&version=1.0&component=gui]`''[[BR]]
    109114
    110 
    111 See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification
     115----
     116See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery