Edgewall Software

Changes between Version 4 and Version 5 of NewTicketGuidelines


Ignore:
Timestamp:
Apr 9, 2015, 1:18:08 PM (4 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • NewTicketGuidelines

    v4 v5  
    1 = Guidelines for Creating a New Ticket =
     1= Guidelines for Creating a New Ticket
    22
    33You are about to file a ticket against Trac.
    44
    5 Please note that this is not a demo or test system. Rather, it is used for the development of Trac itself. If you'd like to see how Trac works, either [TracDownload download] and [TracInstall install] it locally, or check the unofficial [http://www.hosted-projects.com/trac/TracDemo/Demo demo site].
     5Please note that this is not a demo or test system. Rather, it is used for the development of Trac itself. If you would like to see how Trac works, either [TracDownload download] and [TracInstall install] it locally, or check the unofficial [http://www.hosted-projects.com/trac/TracDemo/Demo demo site].
    66
    7 == When Should I Create a New Ticket? ==
     7== When Should I Create a New Ticket?
    88
    99Are you in charge of the Trac installation which displays a failure?
     
    1111He can then decide if the problem needs to be fixed locally or in Trac itself.
    1212
    13 === Support and Installation Issues ===
     13=== Support and Installation Issues
    1414
    1515Support and installation questions should be asked on the [MailingList mailing list] or [IrcChannel IRC channel], not filed as tickets. Be sure to review the mailing list archives first, as a lot of common installation issues are already covered there.
    1616
    17 === Isn't There Already a Similar Ticket? ===
     17=== Isn't There Already a Similar Ticket?
    1818
    1919Please check whether the issue you've encountered has been reported before.
    20 At the time of this writing, we have 732 duplicates on a total of 3928 valid tickets, so that's nearly one out of five tickets which shouldn't have been created in the first place. Some issues have even been reported dozens of time, see our MostFrequentDuplicates tickets.
     20At the time of this writing, we have 732 duplicates on a total of 3928 valid tickets, so that's nearly one out of five tickets which shouldn't have been created in the first place. Also see our MostFrequentDuplicates tickets.
    2121
    22 When you have an error message, it's a good idea to copy/paste it in the search box, enclosed in "..." (for an exact match).
     22When you have an error message, it's a good idea to copy/paste it in the search box, enclosed in "...", for an exact match.
    2323
    2424If not, pick a few keywords and do a search on them. If you have a more precise knowledge about the issue, you can try a [/query custom query], where you can easily filter tickets based on various criteria.
    2525
    26 === If you're Still Unsure... ===
     26=== If you're Still Unsure
    2727
    28 Well, create the new ticket anyway, we won't bite you ;)
     28Well, create the new ticket anyway, but please observe the guidelines below.
    2929
    30 == How to Proceed? ==
     30== How to Proceed?
    3131
    32 So the issue you want to report has not been addressed before, and you're confident it's about time to create a new ticket for it.
     32So the issue you want to report has not been addressed before, and you are confident it's about time to create a new ticket for it.
    3333
    34 Please follow those guidelines:
     34Please follow these guidelines:
    3535 - Provide a concise and precise '''Summary'''. As when you write an e-mail,
    3636   the ticket's summary is the first thing people will see about this ticket,
    3737   in the timeline, reports and other places in Trac, so it's quite important to get it right.
    3838 - What's the appropriate Ticket '''Type'''? Is this a ''Defect'' report or an ''Enhancement'' request?
    39    A defect is an existing feature not working as advertised,
    40    adding a missing feature is an enhancement request, however important that feature is to you
    41    (you can use the ''severity'' field for ranking that).
     39   A defect is an existing feature not working as advertised. A
     40   missing feature is an enhancement request, regardless of how important that feature is to you
     41   and you can use the ''severity'' field for ranking that.
    4242 - The '''Description''' is the place where you give all the details about the issue.
    4343   Good descriptions for a problem report are the ones that make it easy for the developer
    4444   to understand and/or reproduce the problem.
    4545   To that end, it's usually necessary to give the following information:
    46    - ''How To Reproduce'': describe what you were doing when the problem happened.
    47      //**Someone following those instructions should be able to reproduce the problem.**//
     46   - ''How To Reproduce'': describe what you were doing when the problem happened, so that someone following those instructions should be able to reproduce the problem.
    4847   - ''System Information'': list the software components involved with their version
    4948     - the Operating System
    5049     - the Python version used
    5150     - the database backend and their bindings if relevant
    52      - the versioning system and their bindings if relevant, etc.).
     51     - the versioning system and their bindings if relevant
    5352     - for Trac itself, you should pick the appropriate ''version'' from the drop down list.
    54        If `devel` is chosen (which usually means you're using [source:trunk] or a [source:sandbox branch],
    55        you should additionally specify the branch used, and the precise revision number used).
     53       If `devel` is chosen, which usually means you're using [source:trunk] or a [source:sandbox branch],
     54       you should additionally specify the branch used, and the precise revision number used.
    5655       Also, if you're using a patched version, it's necessary to refer to the patches used.
    5756   - ''Python backtrace'': if you have one, append it at the end of the description,
    5857     enclosed in a `{{{` ... `}}}` block.
    59  - The following ticket fields //**should be correctly set by you**//:
     58 - The following ticket fields and should be correctly set by you:
    6059   - The '''Version''' of the Trac software you were using. This can usually be seen in the ''About'' page.
    6160   - The '''Component''' specifies the subsystem of Trac in which the error happened or where the enhancement should be made
    6261   - The '''Severity''' is a rough estimation of the impact of the problem or the importance of the enhancement
    63    - The '''Keywords''' can contain a few important words about the issue (though we tend to use some conventions about the keywords themselves, see TracTicketTriage#Keywords for more details).
    64  - The following ticket fields //**should be left empty**//:
    65    - The '''Assign to''' person will be the developer taking responsibility for the ticket, or the patch contributor if the patch is good enough to be mostly applied as is
    66    - The '''Priority''' will be arbitrarily set by a Trac developer ;)
     62   - The '''Keywords''' can contain a few important words about the issue, though we tend to use some conventions about the keywords themselves, see TracTicketTriage#Keywords for more details.
     63 - The following ticket fields should be left empty:
     64   - The '''Assign to''' person will be the developer taking responsibility for the ticket, or the patch contributor if the patch is good enough to be mostly applied as is.
     65   - The '''Priority''' will be arbitrarily set by a Trac developer.
    6766   - The '''Milestone''' will also be set by us **after** the [TracTicketTriage ticket triage].
    6867     So it's important to leave the  milestone field ''empty'', which is used by us as an indicator that the ticket has not yet been triaged.
    6968
    70 Please take all these guidelines with a grain of salt, those are not strict rules, only hints for improving the ongoing development process of Trac itself!
     69Please take all these guidelines as hints for improving the ongoing development process of Trac itself!
    7170
    7271-- The TracTeam