Changes between Version 2 and Version 3 of BugReporting


Ignore:
Timestamp:
Aug 25, 2015, 11:39:28 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • BugReporting

    v2 v3  
    1 = How to Report Bugs =
     1= How to Report Bugs
    22
    3 If you'll find a bug in any plugin and you'd like to get know to author, you should collect some usefull information before making a [http://trac-hacks.org/newticket new ticket]. You can use this link where you correctly fill in "Component" and "Assigned To" fileds to make a ticket but better is to use direct links at plugins' home pages.
     3If you find a bug in a plugin and you would like the author or maintainer to know about it, you should collect some useful information before creating a [http://trac-hacks.org/newticket new ticket]. You can use this link where you correctly fill in "Component" and "Assigned To" fields to make a ticket, but it is better to use the direct links at plugins' home pages.
    44
    5 == Describing Bug ==
     5== Describing Bug
    66
    7 First of all you should find out how  your bug can be evoked. Sometimes it's obvious but sometimes is needs special succesion of steps and specific system configuration. However write a few sentences about that could help a lot anytime. If you'll not manage to evoke your bug once more make a ticket anyway but make a note about that.
     7First of all you should find out how your bug can be replicated. Sometimes it's obvious, but sometimes it requires a specific succession of steps and a specific system configuration. Writing a few sentences about that will help a lot. If you are unable to replicate your bug, make a ticket anyway, but make a note about that.
    88
    9 == Collecting Debug Messages ==
     9== Collecting Debug Messages
    1010
    11 Plugins should use debug messages logged to file to help determining where is a problem where it occurs. If your bug is not only functional one but it's provided by error message or traceback, you should collect debug messages too. There is two ways how to enable logging on debug level.
     11Plugins should use debug messages logged to file to help determining where the problem occurs. If your bug is not only functional, but it is provided by error message or traceback, you should collect the debug messages too. There are two ways to enable logging on debug level.
    1212
    13 First, the hard one, is described [http://trac.edgewall.org/wiki/TracLogging here]. For our purposes it is needed to set these variables in trac.ini configuration file:
     13First, the hard one, is described [http://trac.edgewall.org/wiki/TracLogging here]. For our purposes it is needed to set these variables in your `trac.ini` configuration file:
    1414
    15 {{{
     15{{{#!ini
    1616[logging]
    1717log_type = file
    … …  
    2121The second one is easier but you have to have had WebAdminPlugin installed. Just go to "Admin" section and "Logging" page and set there "Type" field to "file" and "Log level" field to "DEBUG".
    2222
    23 You will probably need to restart your web server after changing that in both cases. Then evoke your bug again go to "<trac_environment_path>/log/" folder and open log file named trac.log (by default). There collect any relevant lines near error message that you think that are relevant or few tens if you are not sure about that and post them to ticket. Don't forget to enclose these lines in triple brackets (!{{{ }}}) when pasting the content into a ticket.
     23You will probably need to restart your web server after changing that in both cases. Then replicate your bug again go to "<trac_environment_path>/log/" folder and open log file named trac.log (by default). There collect any relevant lines near error message that you think are relevant or few tens if you are not sure about that and post them in the ticket. Don't forget to enclose these lines in triple brackets (!{{{ }}}) when pasting the content into a ticket.
    2424
    25 == Describing Your System ==
     25== Describing Your System
    2626
    27 Many bugs are platform dependend so you should sumarize your system information in the begining of ticket. Relevant is your exact Trac version (0.10.3, SVN trunk r3500, ...), web server you are running trac at (Apache+CGI, Apache+mod_python, tracd, ...), database backend (sqlite, PostgreSQL, MySQL, ...), database bindings (pysqlite, ...), operating system (Windows, Linux, MacOS, ...) and of course plugin's version. Example of that info could look like here:
     27Many bugs are platform dependent, so you should sumarize your system information in the begining of the ticket. Relevant is your exact Trac version (0.10.3, SVN trunk r3500, ...), web server you are running trac at (Apache+CGI, Apache+mod_python, tracd, ...), database backend (sqlite, PostgreSQL, MySQL, ...), database bindings (pysqlite, ...), operating system (Windows, Linux, MacOS, ...) and of course the plugin's version. Example:
    2828
    2929{{{
    … …  
    3535}}}
    3636
    37 == Sumary ==
     37== Summary
    3838
    39 Not all information is needed in all cases but if you are not sure it's better to put it all in the ticket. If you'll stick with that, developers would love you :-).
     39Not all information is needed in all cases, but if you are not sure, it's better to put all of it in the ticket.