Changes between Version 2 and Version 3 of TracTickets


Ignore:
Timestamp:
Apr 22, 2015, 3:10:33 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracTickets

    v2 v3  
    22[[TracGuideToc]]
    33
    4 The Trac ticket 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.
     11
     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.
    1214
    1315== Ticket Fields ==
    1416
    15 A  ticket contains the following information attributes:
     17A ticket contains the following information:
    1618 
    17  * '''Reporter''' - The author of the ticket.
    18  * '''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.
    1932
    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.
     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].
    2335
    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.
     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.
    3337
    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 [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.
    37 
    38 '''Note:''' Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes]
     38 - Description of the builtin ''priority'' values is available at [trac:TicketTypes#Whyistheseverityfieldgone TicketTypes]
    3939
    4040== Changing and Commenting Tickets ==
    4141
    42 Once a ticket has been entered into Trac, you can at any time change the
    43 information by '''annotating''' the bug. This means changes and comments to
    44 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'''.
    4543
    46 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.
    4745
    48 ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes
    49 understanding the motivation behind a design- or implementation choice easier,
    50 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.
    5147
    52 '''Note:''' An important feature is being able to use TracLinks and
    53 WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
    54 other issues, changesets or files to make your ticket more specific and easier
    55 to understand.
     48All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket.
    5649
    57 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.
    5850
    59 '''Note:''' See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.
     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.
     53
     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.
    6057
    6158== Default Values for Drop-Down Fields ==
     
    6966 * `default_type`: Default ticket type
    7067 * `default_version`: Name of the default version
    71  * `default_owner`: Name of the default owner, ''if no owner for the component has been set''
     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.  Some of these can be chosen through the [trac:WebAdmin WebAdmin] plugin in the "Ticket System" section (others in the "trac.ini" section).  The default owner for a ticket will be the component owner, if that is set, or `default_owner`, if not.
     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
     
    8582If 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.
    8683
    87 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, or simply by authenticating if the user has a login. Also, the user must have `TICKET_MODIFY` [TracPermissions permissions].
     84To appear in the dropdown list, a user needs be registered with the project, ie 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].
    8885
    89 '''Note:''' 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
     86'''Notes:'''
     87 - 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.
    9088
    91 '''Note 2:''' 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)
     89 - 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].
    9290
    93 '''Note 3:''' Activating this option may cause some performance degradation, read more about this in the [trac:TracPerformance#Configuration Trac performance] page.
     91 -  Activating this option may cause some performance degradation. Read more about this in the [trac:TracPerformance#Configuration Trac performance] page.
    9492
    9593== Preset Values for New Tickets ==
    9694
    97 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 &.
     95To 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:
    9896
    99 Possible variables are :
     97 * '''type''' — The type droplist
     98 * '''reporter''' — Name or email of the reporter
     99 * '''summary''' — Summary line for the ticket
     100 * '''description''' — Long description of the ticket
     101 * '''component''' — The component droplist
     102 * '''version''' — The version droplist
     103 * '''severity''' — The severity droplist
     104 * '''keywords''' — The keywords
     105 * '''priority''' — The priority droplist
     106 * '''milestone''' — The milestone droplist
     107 * '''owner''' — The person responsible for the ticket
     108 * '''cc''' — The list of emails for notifying about the ticket change
    100109
    101  * '''type''' - The type droplist
    102  * '''reporter''' - Name or email of the reporter
    103  * '''summary''' - Summary line for the ticket
    104  * '''description''' - Long description of the ticket
    105  * '''component''' - The component droplist
    106  * '''version''' - The version droplist
    107  * '''severity''' - The severity droplist
    108  * '''keywords''' - The keywords
    109  * '''priority''' - The priority droplist
    110  * '''milestone''' - The milestone droplist
    111  * '''owner''' - The person responsible for the ticket
    112  * '''cc''' - The list of emails for notifying about the ticket change
    113 
    114 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''[[BR]]
     110Example: ''`[/newticket?summary=Compile%20Error&version=1.0&component=gui]`''
    115111
    116112----