Changes between Version 1 and Version 2 of TracTickets


Ignore:
Timestamp:
Aug 15, 2016, 5:36:15 PM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTickets

    v1 v2  
    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 way to track issues and software 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.
    99
    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.
     10An issue is assigned to a person who must resolve it or reassign the ticket to someone else. All tickets can be edited, annotated, assigned, prioritized and discussed at any time.
    1211
    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.
     12[=#edit-permissions]
     13However, a Trac installation may place restrictions on 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.
    1414
    1515== Ticket Fields ==
    1616
    17 A  ticket contains the following information attributes:
     17A ticket contains the following information:
    1818 
    19  * '''Reporter''' - The author of the ticket.
    20  * '''Type''' - The nature of the ticket (for example, defect or enhancement request)
     19 * '''Reporter''' — The author of the ticket.
     20 * '''Type''' — The category of the ticket. The default types are `defect`,  `enhancement` and `task`.
     21 * '''Component''' — The project module or subsystem this ticket concerns.
     22 * '''Version''' — Version of the project that this ticket pertains to.
     23 * '''Keywords''' — Keywords that a ticket is marked with. Useful for searching and report generation.
     24 * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''. A pull-down if different priorities are defined.
     25 * '''Milestone''' — Due date of when this issue should be resolved. A pull-down menu containing a list of milestones.
     26 * '''Assigned to/Owner''' — Principal person responsible for handling the issue.
     27 * '''Cc''' — A comma-separated list of other users or email addresses to notify. ''Note that this does not imply responsibility or any other policy.''
     28 * '''Resolution''' — Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}.
     29 * '''Status''' — What is the current status? The statuses are defined in the [TracWorkflow#BasicTicketWorkflowCustomization ticket workflow]. For the default workflow the statuses are `new`, `assigned`, `accepted`, `closed` and `reopened`.
     30 * '''Summary''' — A description summarizing the issue. Simple text without WikiFormatting.
     31 * '''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point. Accepts WikiFormatting.
    2132
    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.
     33'''Notes:'''
     34 - 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].
    2535
    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.
     36 - 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.
    3537
    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 - Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes]
    3839
    3940== Changing and Commenting Tickets ==
    4041
    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.
     42With appropriate permissions, as already mentioned [#edit-permissions above], a ticket entered into Trac can at any time be modified by '''annotating'''.
    4443
    45 When viewing a ticket, the history of changes will appear below the main ticket area.
     44Then, 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.
    4645
    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.''
     46Comment 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.
    5047
    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.
     48All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket.
    5549
    56 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.
    5750
    58 === State Diagram ===
    59 http://projects.edgewall.com/trac/attachment/wiki/TracTickets/Trac%20Ticket%20State%20Chart%2020040607DF.png?format=raw
     51'''Notes:'''
     52 - 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.
    6053
     54 - See TracNotification for how to configure email notifications of ticket changes.
     55
     56 - See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.
    6157
    6258== Default Values for Drop-Down Fields ==
    … …  
    6460The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section:
    6561
    66  * `default_type`: Default ticket type
    6762 * `default_component`: Name of the component selected by default
    68  * `default_version`: Name of the default version
    6963 * `default_milestone`: Name of the default milestone
    7064 * `default_priority`: Default priority value
    7165 * `default_severity`: Default severity value
     66 * `default_type`: Default ticket type
     67 * `default_version`: Name of the default version
     68 * `default_owner`: Name of the default owner. If set to the text `< default >` (the default value), the component owner is used.
    7269
    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.
     70If 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 can be set in the [[wiki:TracIni#ticket-section|"[ticket]"]] section in `trac.ini`.
    7471
    7572
    … …  
    8380== Assign-to as Drop-Down List ==
    8481
    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.
     82If 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 populate the list with all users who have authenticated with the project and possess the  `TICKET_MODIFY` [TracPermissions permissions].
    8683
    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.''
     84You may find the dropdown list is //overpopulated// with users that are no longer active in the project. Revoking authentication privileges will not remove the session data that is used to populate the dropdown list. The [wiki:TracAdmin trac-admin] command can be used to list and remove sessions:
    8885
     86 - List all sessions:
     87{{{#!sh
     88trac-admin /path/to/projenv session list
     89}}}
     90 - Remove a session:
     91{{{#!sh
     92trac-admin /path/to/projenv session delete SID
     93}}}
     94
     95Alternatively, you can just revoke `TICKET_MODIFY` from users that you don't want to be included in the list. However, that will not be possible if you've granted `TICKET_MODIFY` to all //anonymous// or //authenticated// users.
     96
     97'''Notes:'''
     98 - 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].
     99
     100 -  Activating this option may cause some performance degradation. Read more about this in the [trac:TracPerformance#Configuration Trac performance] page.
    89101
    90102== Preset Values for New Tickets ==
    91103
    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 &.
     104To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with `variable=value` separated by `&`. Possible variables are:
    93105
    94 Possible variables are :
     106 * '''type''' — The type droplist
     107 * '''reporter''' — Name or email of the reporter
     108 * '''summary''' — Summary line for the ticket
     109 * '''description''' — Long description of the ticket
     110 * '''component''' — The component droplist
     111 * '''version''' — The version droplist
     112 * '''severity''' — The severity droplist
     113 * '''keywords''' — The keywords
     114 * '''priority''' — The priority droplist
     115 * '''milestone''' — The milestone droplist
     116 * '''owner''' — The person responsible for the ticket
     117 * '''cc''' — The list of emails for notifying about the ticket change
    95118
    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
     119Example: ''`[/newticket?summary=Compile%20Error&version=1.0&component=gui]`''
    107120
    108 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''
    109 
    110 
    111 See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification
     121----
     122See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery