Difference between revisions of "Bug Tracking System"

From MythTV Official Wiki
Jump to: navigation, search
(Etiquette)
(Misc tidy-ups, include info on discussing bugs)
Line 1: Line 1:
= Trac =
+
Myth now uses [http://svn.mythtv.org/trac Trac], a popular bug-tracking system.  When submitting bugs, there are a few rules and suggestions you should follow.
Myth now uses [http://svn.mythtv.org/trac trac] to track bugs.  Trac is a popular bug tracking system.  There are a few rules/suggestions you should follow if you want to submit a bug
 
  
== Etiquette ==
 
 
* '''Read the [http://svn.mythtv.org/trac/wiki/TicketHowTo Ticket HowTo] and once done, read it again'''
 
* '''Read the [http://svn.mythtv.org/trac/wiki/TicketHowTo Ticket HowTo] and once done, read it again'''
* Use the most recent subversion version.
+
* Report bugs against the most recent SVN code, or failing that the latest release, and select the appropriate release when submitting your ticket.
: Bugs are constantly being fixed.  Don't report one that was fixed last week.
+
* Search the [http://svn.mythtv.org/trac/report/1 database] first and make sure the bug has not already been reported. Bugs are constantly being fixed, so if you don't search first, you could easily submit a duplicate ticket for a bug that was fixed recently.  Also look through the [http://mythtv.org/pipermail/mythtv-dev/ -dev list archives], as many bugs are discussed there before they are submitted to Trac.
: (I would personally say use either the most current SVN *or* the most current production release, and make sure to correctly select which when reporting the bug  --[[Bay Link]])
+
* Include accurate description of how to recreate the problem, logs, versions (--version) and a backtrace if the bug involves a crash.
* Make sure the bug is not already reported.
+
* Recompile Myth with debug symbols.  The additional information helps the developers to recognize errors. See [http://www.mythtv.org/docs/mythtv-HOWTO-22.html#ss22.2 HOWTO Chapter 22] for instructions.
: You can search the database, and since the list is somewhat short read all about the current reported bugs [http://svn.mythtv.org/trac/report/1 here].
+
* Try and make sure the error is not your misconfiguration (e.g. you don't have a certain codec installed).
: Also look through the dev list, many bugs are submitted there before they are submitted to Trac.
+
* MythTV's bugs database (unlike some) is '''not''' a [[User Wish List]] or a forum for discussion of bugs.  Do not submit your feature requests there, and don't use the comments for discussion - comments are for concrete debugging information that will assist the developers to fix the bug.  Discussion belongs on the [[Mailing_List]].
* Make sure you understand which program ([[MythWeb]], [[MythGame]] ...) is causing the problem.
 
* Re-compile Myth for debug, the additional debug information helps the developers to recognize errors.
 
: See the [http://www.mythtv.org/docs/mythtv-HOWTO-22.html#ss22.2 HOWTO] for instructions.
 
* Provide backtraces, logs, version numbers (--version) and a accurate description of how to recreate the problem
 
* Try and make sure the error is not yours (eg you don't have the right codec installed)
 
* MythTV's bugs database (unlike some) is '''not''' a [[User Wish List]].  Do not submit your feature requests there.
 
  
Once the bug is submitted, keep track of it.  The developers may have additional questions or requests for you.
+
Once the bug is submitted, keep track of it as the developers may have additional questions or requests for you.
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]

Revision as of 02:01, 7 December 2009

Myth now uses Trac, a popular bug-tracking system. When submitting bugs, there are a few rules and suggestions you should follow.

  • Read the Ticket HowTo and once done, read it again
  • Report bugs against the most recent SVN code, or failing that the latest release, and select the appropriate release when submitting your ticket.
  • Search the database first and make sure the bug has not already been reported. Bugs are constantly being fixed, so if you don't search first, you could easily submit a duplicate ticket for a bug that was fixed recently. Also look through the -dev list archives, as many bugs are discussed there before they are submitted to Trac.
  • Include accurate description of how to recreate the problem, logs, versions (--version) and a backtrace if the bug involves a crash.
  • Recompile Myth with debug symbols. The additional information helps the developers to recognize errors. See HOWTO Chapter 22 for instructions.
  • Try and make sure the error is not your misconfiguration (e.g. you don't have a certain codec installed).
  • MythTV's bugs database (unlike some) is not a User Wish List or a forum for discussion of bugs. Do not submit your feature requests there, and don't use the comments for discussion - comments are for concrete debugging information that will assist the developers to fix the bug. Discussion belongs on the Mailing_List.

Once the bug is submitted, keep track of it as the developers may have additional questions or requests for you.