Edgewall Software

Changes between Version 56 and Version 57 of TracTickets


Ignore:
Timestamp:
Apr 27, 2011, 6:08:42 AM (13 years ago)
Author:
AdrianFritz
Comment:

Ref. #10086 - update #ChangingandCommentingTickets section

Legend:

Unmodified
Added
Removed
Modified
  • TracTickets

    v56 v57  
    55The Trac ticket database provides simple but effective tracking of issues and bugs within a project.
    66
    7 As the central project management element of Trac, tickets can be used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.
     7As the central project management element of Trac, tickets can be used for '''project tasks''', '''feature requests''', '''bug reports''', '''software support issues''' among others.
    88
    9 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.
     9As 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.
    1010
    1111An issue is assigned to a person who must resolve it or reassign the ticket to someone else.
     
    2020 
    2121 * '''Reporter''' — The author of the ticket.
    22  * '''Type''' — The nature of the ticket (for example, defect or enhancement request)
     22
     23 * '''Type''' — The nature of the ticket (for example, defect or enhancement request). See TicketTypes for more details.
    2324
    2425 * '''Component''' — The project module or subsystem this ticket concerns.
     26
    2527 * '''Version''' — Version of the project that this ticket pertains to.
    26  * '''Keywords''' — Keywords that a ticket is marked with.  Useful for searching and report generation.
    2728
    28  * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''.
    29  * '''Milestone''' — When this issue should be resolved at the latest.
     29 * '''Keywords''' — Keywords that a ticket is marked with. Useful for searching and report generation.
     30
     31 * '''Priority''' — The importance of this issue, ranging from ''trivial'' to ''blocker''. A pull-down if different priorities where defined.
     32
     33 * '''Milestone''' — When this issue should be resolved at the latest. A pull-down menu containing a role of milestones.
     34
    3035 * '''Assigned to/Owner''' — Principal person responsible for handling the issue.
     36
    3137 * '''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.''
    3238 
    3339 * '''Resolution''' — Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}.
     40
    3441 * '''Status''' — What is the current status? One of {{{new}}}, {{{assigned}}}, {{{closed}}}, {{{reopened}}}.
    35  * '''Summary''' — A brief description summarizing the problem or issue.
    36  * '''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point.
     42
     43 * '''Summary''' — A brief description summarizing the problem or issue. Simple text without WikiFormatting.
     44
     45 * '''Description''' — The body of the ticket. A good description should be specific, descriptive and to the point. Accepts WikiFormatting.
    3746
    3847'''Notes:'''
     
    4554== Changing and Commenting Tickets ==
    4655
    47 Once a ticket has been entered into Trac, you can at any time change the
    48 information by '''annotating''' the bug. This means changes and comments to
    49 the ticket are logged as a part of the ticket itself.
    50 As already mentioned [#edit-permissions above], you'll however need the appropriate permissions for doing so.
     56With appropriate permissions, as already mentioned [#edit-permissions above], a ticket entered into Trac can at any time be modified by '''annotating'''.
    5157
    52 When viewing a ticket, the history of changes will appear below the main ticket area.
     58Then, 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.
    5359
    54 ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes
    55 understanding the motivation behind a design- or implementation choice easier,
    56 when returning to it later.''
     60Comment 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.
     61  * Editing a comment will not produce a new entry on [/timeline] while entering a new comment or other changes will do.
     62
     63  * Anyway comments which where edited keep a track of changes, helping for traceability.
     64
     65Updating the "last changed" time is useful to detect any modification to a ticket through an API, as explained in the description.
     66
    5767
    5868'''Notes:'''
    59  - An important feature is being able to use TracLinks and
    60    WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
    61    other issues, changesets or files to make your ticket more specific and easier
    62    to understand.
     69 - 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.
    6370
    6471 - See TracNotification for how to configure email notifications of ticket changes.