Difference between revisions of "File Bugs"

From ReactOS Wiki
Jump to: navigation, search
(Further simplify)
(some more fiddling)
Line 1: Line 1:
This article describes how to file bugs in our [http://reactos.org/bugzilla Bugzilla] Bug-Tracking Software. Bugzilla is used to gather information about failing or misbehaving components and allows to coordinate bug fixing efforts.
+
This page describes how to file bugs in our [http://reactos.org/bugzilla Bugzilla] Bug-Tracking Software. Bugzilla is used to gather information about failing or misbehaving components and allows to coordinate bug fixing efforts.
 +
 
 +
=== First Steps ===
  
 
If you think you found a bug in ReactOS please ensure the following:
 
If you think you found a bug in ReactOS please ensure the following:
  
 
* Make sure you can replicate your bug. Restart ReactOS and try again to make sure.
 
* Make sure you can replicate your bug. Restart ReactOS and try again to make sure.
 +
 
* Check that it hasn't been reported already. The bugzilla search will help you confirm this.
 
* Check that it hasn't been reported already. The bugzilla search will help you confirm this.
 +
 
* Make sure you are testing a recent and official ReactOS build. New nighly builds (preferred testing source) can be obtained [http://www.reactos.org/getbuilds/ here].
 
* Make sure you are testing a recent and official ReactOS build. New nighly builds (preferred testing source) can be obtained [http://www.reactos.org/getbuilds/ here].
 +
 
* If you are running ReactOS on a virtual machine, please mind that we support [[QEMU]], [[VMware]] and [[VirtualBox]]. Others are not supported.
 
* If you are running ReactOS on a virtual machine, please mind that we support [[QEMU]], [[VMware]] and [[VirtualBox]]. Others are not supported.
  
If those points are valid for your bug you most likely found an issue. Since certain bug types are out of the scope of the project make sure the follows points apply:
+
Since certain bug types are out of the scope of the project make sure the follows points apply:
  
* Build breakages on the common platforms (Windows, Linux). Please report build breakages on IRC, or to the [http://www.reactos.org/?page=community_mailinglists ros-dev mailing list].
+
* Do not report build breakages on common platforms (Windows, Linux). Please report these on IRC or to the [http://www.reactos.org/?page=community_mailinglists ros-dev mailing list].
* Features reported to be in the next version of Windows (WinFS, etc..).
 
* Bugs in external components (Freetype, Wine, Mesa etc.). Please use the other projects bug trackers for this purpose.
 
  
To make sure we can fix the bug certain information has to be present. Important data includes:
+
* Do not report features announced for the next version of Windows (WinFS, etc.).
 +
 
 +
* Do not report bugs in external components (Freetype, Wine, Mesa etc.). Please use the other projects bug trackers for this purpose.
 +
 
 +
=== Important Information to Include ===
 +
 
 +
To make sure we can reproduce and  fix your bug certain information has to be present. Important data you should include in your report includes:
 +
 
 +
* Reproduction method using step by step instructions
  
* Reproduction method, step by step approach
 
 
* Hardware or virtual machine configuration
 
* Hardware or virtual machine configuration
 +
 
* Tested ReactOS version (open up a commandline and type 'ver' in case you are unsure)
 
* Tested ReactOS version (open up a commandline and type 'ver' in case you are unsure)
 +
 
* Version of the application tested (if any)
 
* Version of the application tested (if any)
* Screenshot of the problem if it's a graphical bug  
+
 
 +
* Screenshot of the problem if it's a graphical bug
 +
 
 
* Debug log for of crashes, freezes and application errors. See [[Debugging]] on how to obtain high quality debug output
 
* Debug log for of crashes, freezes and application errors. See [[Debugging]] on how to obtain high quality debug output
  
Line 26: Line 40:
  
 
* Choose a concise bug title
 
* Choose a concise bug title
 +
 
* Try not to paste the debug log directly into the bug report, attach it instead. It helps readability.
 
* Try not to paste the debug log directly into the bug report, attach it instead. It helps readability.
 +
 
* Attach pictures to bugzilla directly instead of using external hosting services.
 
* Attach pictures to bugzilla directly instead of using external hosting services.
* Use Bugzilla as a way to file bugs, not to ask for support or discuss other things not related to the bug.
+
 
 +
* Use Bugzilla to file bugs, not to ask for support or discuss things not related to the bug.
 +
 
 
* The bug report should cover a single problem, no matter if it happens in multiple applications or has multiple ways of replicating it.
 
* The bug report should cover a single problem, no matter if it happens in multiple applications or has multiple ways of replicating it.
 +
 
* Do not post more than one issue in a single bug report.
 
* Do not post more than one issue in a single bug report.
  

Revision as of 18:22, 4 June 2010

This page describes how to file bugs in our Bugzilla Bug-Tracking Software. Bugzilla is used to gather information about failing or misbehaving components and allows to coordinate bug fixing efforts.

First Steps

If you think you found a bug in ReactOS please ensure the following:

  • Make sure you can replicate your bug. Restart ReactOS and try again to make sure.
  • Check that it hasn't been reported already. The bugzilla search will help you confirm this.
  • Make sure you are testing a recent and official ReactOS build. New nighly builds (preferred testing source) can be obtained here.
  • If you are running ReactOS on a virtual machine, please mind that we support QEMU, VMware and VirtualBox. Others are not supported.

Since certain bug types are out of the scope of the project make sure the follows points apply:

  • Do not report build breakages on common platforms (Windows, Linux). Please report these on IRC or to the ros-dev mailing list.
  • Do not report features announced for the next version of Windows (WinFS, etc.).
  • Do not report bugs in external components (Freetype, Wine, Mesa etc.). Please use the other projects bug trackers for this purpose.

Important Information to Include

To make sure we can reproduce and fix your bug certain information has to be present. Important data you should include in your report includes:

  • Reproduction method using step by step instructions
  • Hardware or virtual machine configuration
  • Tested ReactOS version (open up a commandline and type 'ver' in case you are unsure)
  • Version of the application tested (if any)
  • Screenshot of the problem if it's a graphical bug
  • Debug log for of crashes, freezes and application errors. See Debugging on how to obtain high quality debug output

To help you reporting and ease the bug fixing process please follow the following reporting guidelines:

  • Choose a concise bug title
  • Try not to paste the debug log directly into the bug report, attach it instead. It helps readability.
  • Attach pictures to bugzilla directly instead of using external hosting services.
  • Use Bugzilla to file bugs, not to ask for support or discuss things not related to the bug.
  • The bug report should cover a single problem, no matter if it happens in multiple applications or has multiple ways of replicating it.
  • Do not post more than one issue in a single bug report.

Bugs that do not follow the guidelines will be closed as INVALID and the reporter will be asked to report the bug properly. If you have any questions or problems regarding the bug reporting process, see the Using Buzilla page or consult amine48rz, Caemyr or gabriel_it on IRC.