Changes between Initial Version and Version 1 of TracTickets

Show
Ignore:
Timestamp:
08/22/08 18:11:06 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTickets

    v1 v1  
     1= The Trac Ticket System = 
     2[[TracGuideToc]] 
     3 
     4The Trac ticket database provides simple but effective tracking of issues and bugs within a project. 
     5 
     6As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.  
     7 
     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 and suggest improvements. 
     9 
     10An issue is assigned to a person who must resolve it or reassign the ticket to someone else. 
     11All tickets can be edited, annotated, assigned, prioritized and discussed at any time. 
     12 
     13== Ticket Fields == 
     14 
     15A  ticket contains the following information attributes: 
     16  
     17 * '''Reporter''' - The author of the ticket. 
     18 * '''Type''' - The nature of the ticket (for example, defect or enhancement request) 
     19 
     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. 
     23 
     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 comma-separated list of other users or E-Mail addresses to notify. ''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. 
     33 
     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 [wiki:TicketTypes type], [wiki:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or with the WebAdmin plugin. 
     37 
     38'''Note:''' Description of the builtin ''priority'' values is available at [wiki:TicketTypes#Whyistheseverityfieldgone] 
     39 
     40== Changing and Commenting Tickets == 
     41 
     42Once a ticket has been entered into Trac, you can at any time change the 
     43information by '''annotating''' the bug. This means changes and comments to 
     44the ticket are logged as a part of the ticket itself. 
     45 
     46When viewing a ticket, the history of changes will appear below the main ticket area. 
     47 
     48''In the Trac project, we use ticket comments to discuss issues and tasks. This makes 
     49understanding the motivation behind a design- or implementation choice easier, 
     50when returning to it later.'' 
     51 
     52'''Note:''' An important feature is being able to use TracLinks and 
     53WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to 
     54other issues, changesets or files to make your ticket more specific and easier 
     55to understand. 
     56 
     57'''Note:''' See TracNotification for how to configure email notifications of ticket changes. 
     58 
     59'''Note:''' See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized. 
     60 
     61== Default Values for Drop-Down Fields == 
     62 
     63The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section: 
     64 
     65 * `default_component`: Name of the component selected by default 
     66 * `default_milestone`: Name of the default milestone 
     67 * `default_priority`: Default priority value 
     68 * `default_severity`: Default severity value 
     69 * `default_type`: Default ticket type 
     70 * `default_version`: Name of the default version 
     71 
     72If 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. 
     73 
     74 
     75== Hiding Fields and Adding Custom Fields == 
     76 
     77Many 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''. 
     78 
     79Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information. 
     80 
     81 
     82== Assign-to as Drop-Down List == 
     83 
     84If 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. 
     85 
     86To 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]. 
     87 
     88== Preset Values for New Tickets == 
     89 
     90To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with variable=value separated by &.  
     91 
     92Possible variables are : 
     93 
     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 
     106 
     107'''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''[[BR]] 
     108 
     109---- 
     110See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery