Changes between Version 1 and Version 2 of TracTickets


Ignore:
Timestamp:
Jul 30, 2012 5:30:50 PM (12 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 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. 
     12 
     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. 
    1215 
    1316== Ticket Fields == 
    … …  
    1518A  ticket contains the following information attributes: 
    1619  
    17  * '''Reporter''' - The author of the ticket. 
    18  * '''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. 
    1933 
    20  * '''Component''' - The project module or subsystem this ticket concerns. 
    21  * '''Version''' - Version of the project that this ticket pertains to. 
    22  * '''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]. 
    2336 
    24  * '''Priority''' - The importance of this issue, ranging from ''trivial'' to ''blocker''. 
    25  * '''Milestone''' - When this issue should be resolved at the latest. 
    26  * '''Assigned to/Owner''' - Principal person responsible for handling the issue. 
    27  * '''Cc''' - A list of other associated people. ''Note that this does not imply responsiblity or any other policy.'' 
    28   
    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. 
    32  * '''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. 
    3338 
    34 '''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]. 
    35  
    36 '''Note:''' the ''type'' (TicketTypes), ''component'' (TicketComponent), ''version'' (TicketVersion), ''priority'' (TicketPriority) and ''severity'' (TicketSeverity) fields can all be managed through [wiki:TracAdmin trac-admin]. 
     39 - Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes] 
    3740 
    3841== Changing and Commenting Tickets == 
    3942 
    40 Once a ticket has been entered into Trac, you can at any time change the 
    41 information by '''annotating''' the bug. This means changes and comments to 
    42 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'''. 
    4344 
    44 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. 
    4546 
    46 ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes 
    47 understanding the motivation behind a design- or implementation choice easier, 
    48 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. 
    4948 
    50 '''Note:''' An important feature is being able to use TracLinks and 
    51 WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to 
    52 other issues, changesets or files to make your ticket more specific and easier 
    53 to understand. 
     49All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket. 
    5450 
    55 '''Note:''' See TracNotification for how to configure email notifications of ticket changes. 
    5651 
    57 === State Diagram === 
    58 [[Image(http://projects.edgewall.com/trac/attachment/wiki/TracTickets/Trac%20Ticket%20State%20Chart%2020060603DF.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. 
    5954 
     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. 
    6058 
    6159== Default Values for Drop-Down Fields == 
    … …  
    6967 * `default_type`: Default ticket type 
    7068 * `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. 
    7170 
    72 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`). 
    7372 
    7473 
    … …  
    8281== Assign-to as Drop-Down List == 
    8382 
    84 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. 
    8584 
    86 To 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. Also, the user must have `TICKET_MODIFY` [TracPermissions permissions]. 
     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]. 
     86 
     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. 
    8793 
    8894== Preset Values for New Tickets == 
    8995 
    90 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 `&`.  
    9197 
    9298Possible variables are : 
    9399 
    94  * '''type''' - The type droplist 
    95  * '''reporter''' - Name or email of the reporter 
    96  * '''summary''' - Summary line for the ticket 
    97  * '''description''' - Long description of the ticket 
    98  * '''component''' - The component droplist 
    99  * '''version''' - The version droplist 
    100  * '''severity''' - The severity droplist 
    101  * '''keywords''' - The keywords  
    102  * '''priority''' - The priority droplist 
    103  * '''milestone''' - The milestone droplist 
    104  * '''owner''' - The person responsible for the ticket 
    105  * '''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 
    106112 
    107 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui'' 
     113Example: ''`[/newticket?summary=Compile%20Error&version=1.0&component=gui]`''[[BR]] 
    108114 
    109115---- 
    110 See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification 
     116See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery