This recipe shows you how to file a bug report in a right way.
Go to the QGIS bugtracker at http://hub.qgis.org/projects/quantum-gis/issues and use your OSGeo User ID and password to log in. The Login link is located in the top-right corner of the page.
Before creating a new bug report, it is necessary to make sure this bug has not yet been reported. To do this, perform the following steps:
- Go to the Issues tab.
- In the Filters group, add and configure the necessary filters. For example, the following filters:
- Status: Configure this to find only open issues
- Subject: Configure this to find issues with the given substring in the Subject field
- Click on the Apply link above the issues list to apply your filters:
- Check whether the resulting list contains issues that are similar to one that you found.
All tickets that match your criteria will be listed in the table.
Also, it makes sense to try to find similar issues with the ordinal search functionality:
- Open the Search page at https://hub.qgis.org/search/index/quantum-gis.
- Enter the keywords in the field.
- Select QGIS Application from the combobox.
- If necessary, perform the search only in ticket titles by activating the corresponding checkbox.
- Deactivate all checkboxes under the search field except Issues to find only issues with given keywords.
- Click on the Submit button to start the search.
Results will be displayed as a raw list of all existing tickets (open and closed), which contain keywords in their titles and description:
If your issue is already reported, add your observations to it. If you cannot find anything similar to your problem, it is time to submit a bug report. To do this, perform the following steps:
- Log in to the QGIS bugtracker with your OSGeo user ID and password.
- Go to the QGIS Application project at http://hub.qgis.org/projects/quantum-gis.
- Open the New issue tab by clicking on the corresponding link in the menu and populate the form with the requested information:
This form contains many fields, the most important ones are listed as follows:
- Tracker: This defines the ticket type. For bug reports, select Bug Report.
- Subject: This is a short and clear description of the problem. It will be used as the ticket title.
- Description: This is a full description of the issue. Describe your problem in detail and provide steps to reproduce it. If there are any debug messages in the console, backtraces, or minidumps, include or attach them, as well as the sample dataset. If you suspect that bug is related to the specific platform version or a specific version of the third-party dependency package (for example, GDAL, GEOS, SpatiaLite, and so on) provide this information too.
- Priority: This is where you set the anticipated importance of the bug. Currently, the following classification is used:
- Low: This is used for bugs that does not affect day-to-day usage of QGIS
- Normal: This is the default value for all new bug reports and feature requests
- High: This is used for bugs that have a significant impact on QGIS usability in some cases, but at the same time, they do not block QGIS usage in other tasks
- Blocker: This is used for bugs that make QGIS totally unusable, leads to data loss or corruption, or for regressions from previous QGIS versions
- Component: This chooses the most appropriate subsystem of QGIS, which is closely related to the issue.
- Platform and Platform version: This specifies the operating system and its version, respectively.
- Causes crash or corruption: This activates the checkbox if the bug causes a QGIS crash or data loss or corruption.
Check the formatting of the bug report by clicking on the Preview link at the bottom. To submit a bug report, click on the Submit button.
Bug Tracker is a database with information about bugs. Developers look over bug queue and arrange them according to priorities, available resources, and fix them. Fixes usually go to the development version (the so-called "master"), but fixes for regressions and important bugs also go to the long-term release branch.
Using the QGIS Bug Tracker, you also can leave feature requests and submit patches. However, for the latter, creating a pull-request at GitHub is preferable.