Changes between Version 1 and Version 2 of TracTickets


Ignore:
Timestamp:
Feb 25, 2025, 12:53:26 PM (3 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTickets

    v1 v2  
    1 = The Trac Ticket System =
     1= The Trac Ticket System
    22[[TracGuideToc]]
    33
    4 The Trac issue database provides simple but effective tracking of issues and bugs within a project.
     4The Trac ticket system provides a 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 '''bug reports''',  '''feature requests''', '''software support issues''' and '''project tasks'''.
     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 to make 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 of WikiStart, or contact your local Trac administrator.
    1414
    15 == Ticket Fields ==
     15== 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  * '''Component''' - The project module or subsystem this ticket concerns.
    21  * '''Version''' - Version of the project that this ticket pertains to.
    22  * '''Severity''' - What are the effects the issue described? Ranges from an ''enhancement'' request to ''blocker'' (must be fixed before next milestone).
    23  * '''Priority''' - The importance of is the issue relative to other tasks.
    24  * '''Milestone''' - When this issue should be resolved at the latest.
    25  * '''Resolution''' - Reason for why a ticket was closed, such as fixed, invalid, duplicate, etc.
    26  * '''Keywords''' - Keywords that a ticket is marked with.  Useful for searching and report generation.
    27  * '''Assigned to''' - Principal person responsible for handling the issue.
    28  * '''Cc''' - A list of other associated people. ''Note: this does '''not''' imply responsibility or any other policy.
    29  * '''Status''' - What is the current status?
    30  * '''Summary''' - A brief description summarizing the problem or issue.
    31  * '''Description''' - The body of the ticket. A good description should be '''specific, descriptive and to the point'''.
     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 that this ticket concerns.
     22 * '''Version''' — Version of the project that this ticket pertains to.
     23 * '''Keywords''' — Keywords that a ticket is tagged with. Useful for searching and report generation.
     24 * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''. A dropdown list when multiple priorities are defined.
     25 * '''Milestone''' — Due date of when this issue should be resolved. A dropdown list containing the 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.
    3232
    33 == Changing and Commenting Tickets ==
     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].
    3435
    35 Once a ticket has been entered into Trac, you can at any time change the
    36 information by '''annotating''' the bug. This means changes and comments to
    37 the ticket are logged as a part of the ticket itself.
     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.
    3837
    39 When viewing a ticket, this log of changes will appear below the main ticket area.
     38 - Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes]
    4039
    41 ''In the Trac project, we use ticket comments to discuss issues and
    42 tasks. This makes understanding the motivation behind a design- or implementation choice easier, when returning to it later.''
     40== Changing and Commenting Tickets
    4341
    44 '''Note:''' An important feature is being able to use TracLinks and
    45 WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
    46 other issues, changesets or files to make your ticket more specific and easier
    47 to understand.
     42With appropriate permissions, as already mentioned [#edit-permissions above], a ticket entered into Trac can at any time be modified by '''annotating'''.
    4843
    49 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.
     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.
    5045
    51 === State Diagram ===
    52 http://projects.edgewall.com/trac/attachment/wiki/TracTickets/Trac%20Ticket%20State%20Chart%2020040607DF.png?format=raw
     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.
    5347
    54 == Advanced: Preset values for New Tickets from URL ==
     48All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket.
    5549
    56 To create a link to the new-icket form filled with preset values, you need to call the /newticket? URL with variable=value separated by &.
     50'''Notes:'''
     51 - 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.
    5752
    58 Possible variables are :
     53 - See TracNotification for how to configure email notifications of ticket changes.
    5954
    60  * '''reporter''' - Name or email of the reporter
    61  * '''summary''' - Summary line for the ticket
    62  * '''description''' - Long description of the ticket
    63  * '''component''' - The component droplist
    64  * '''version''' - The version droplist
    65  * '''severity''' - The severity droplist
    66  * '''keywords''' - The keywords
    67  * '''priority''' - The priority droplist
    68  * '''milestone''' - The milestone droplist
    69  * '''owner''' - The responsable of the ticket
    70  * '''cc''' - The list of email for notify the ticket change
     55 - See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.
    7156
    72 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''
     57== Default Values for Drop-Down Fields
    7358
     59The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section:
    7460
    75 See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification
     61 * `default_component`: Name of the component selected by default.
     62 * `default_milestone`: Name of the default milestone.
     63 * `default_priority`: Default priority value.
     64 * `default_severity`: Default severity value.
     65 * `default_type`: Default ticket type.
     66 * `default_version`: Name of the default version.
     67 * `default_owner`: Name of the default owner. If set to the text `< default >` (the default value), the component owner is used.
     68
     69If 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`.
     70
     71== Hiding Fields and Adding Custom Fields
     72
     73Many 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''.
     74
     75Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information.
     76
     77== Assign-to as Drop-Down List
     78
     79If 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 an authenticated session** and possess the `TICKET_MODIFY` [TracPermissions permissions].
     80
     81An authenticated session will be created the first time a user authenticates with the project. You can manually add an authenticated session using the ["TracAdmin#?session add" trac-admin] `session add` command. The `:1` suffix on the session id (i.e. username) is the key to creating an authenticated session:
     82{{{#!sh
     83trac-admin /path/to/projenv session add <sid>:1 [name] [email]
     84}}}
     85
     86You 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:
     87
     88 - List all sessions:
     89{{{#!sh
     90trac-admin /path/to/projenv session list
     91}}}
     92 - Remove a session:
     93{{{#!sh
     94trac-admin /path/to/projenv session delete SID
     95}}}
     96
     97Alternatively, 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.
     98
     99'''Notes:'''
     100 - If you need more flexibility and aren't afraid of a little plugin coding of your own, see the [https://trac-hacks.org/wiki/FlexibleAssignToPlugin FlexibleAssignTo plugin].
     101 
     102 - Activating this option may cause some performance degradation. Read more about this in the [trac:TracPerformance#Configuration Trac performance] page.
     103
     104== Preset Values for New Tickets
     105
     106To 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:
     107
     108 * '''type''' — The type droplist.
     109 * '''reporter''' — Name or email of the reporter.
     110 * '''summary''' — Summary line for the ticket.
     111 * '''description''' — Long description of the ticket.
     112 * '''component''' — The component dropdown list.
     113 * '''version''' — The version dropdown list.
     114 * '''severity''' — The severity dropdown list.
     115 * '''keywords''' — The keywords or tags.
     116 * '''priority''' — The priority dropdown list.
     117 * '''milestone''' — The milestone dropdown list.
     118 * '''owner''' — The person responsible for the ticket.
     119 * '''cc''' — The list of emails for notifying about the ticket change.
     120
     121Example: `[/newticket?summary=Compile%20Error&version=1.0&component=gui]`
     122
     123----
     124See also: TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery