Difference between revisions of "Bugzilla"
(Remove __NOTOC__ as you can alway hide the TOC but some need the TOC for their references) |
(Restructuring; Drop 'reset the bug status' (the user can not)) |
||
| Line 1: | Line 1: | ||
| + | This page describes the normal usage of Bugzilla. For Quality Assurance (QA) tasks see [[QA/BugzillaAdministration]]. | ||
| + | == Introduction == | ||
If you discover a problem with the program or its documentation (known as a ''bug''), you may want to record the bug so that it can be fixed by the developers. The GnuCash project uses the [http://bugzilla.gnome.org/ Bugzilla] repository maintained by the [http://www.gnome.org/ Gnome Project]. Bugzilla includes ''bugs'' and ''enhancement requests'' for a wide number of projects, including GnuCash. | If you discover a problem with the program or its documentation (known as a ''bug''), you may want to record the bug so that it can be fixed by the developers. The GnuCash project uses the [http://bugzilla.gnome.org/ Bugzilla] repository maintained by the [http://www.gnome.org/ Gnome Project]. Bugzilla includes ''bugs'' and ''enhancement requests'' for a wide number of projects, including GnuCash. | ||
| − | Because Bugzilla | + | Because Gnomes Bugzilla manages bugs for many projects, it can be useful to see only bugs of GnuCash. There is a specific [https://bugzilla.gnome.org/browse.cgi?product=GnuCash GnuCash "Product" page] which allows you to see GnuCash bugs. On this page, you can see the bugs for GnuCash arranged by component. The number of bugs for each component is clickable, and will display the list of the open bugs for that component. |
== Triage == | == Triage == | ||
| Line 11: | Line 13: | ||
* [http://bugzilla.gnome.org/buglist.cgi?product=GnuCash&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&namedcmd=Gnucash+Bugs&newqueryname=Gnucash+Bugs&order=Bug+Number&form_name=query Search for open GnuCash bugs and enhancements] | * [http://bugzilla.gnome.org/buglist.cgi?product=GnuCash&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&namedcmd=Gnucash+Bugs&newqueryname=Gnucash+Bugs&order=Bug+Number&form_name=query Search for open GnuCash bugs and enhancements] | ||
* [http://bugzilla.gnome.org/buglist.cgi?product=GnuCash&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&namedcmd=Gnucash+Bugs&newqueryname=Gnucash+Bugs&order=Bug+Number&form_name=query&version=2.0.x&version=CVS&version=SVN&version=unspecified Search for open GnuCash bugs and enhancements, restricted to post-1.8 or unspecified versions] | * [http://bugzilla.gnome.org/buglist.cgi?product=GnuCash&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&namedcmd=Gnucash+Bugs&newqueryname=Gnucash+Bugs&order=Bug+Number&form_name=query&version=2.0.x&version=CVS&version=SVN&version=unspecified Search for open GnuCash bugs and enhancements, restricted to post-1.8 or unspecified versions] | ||
| + | |||
| + | === Other Resources === | ||
| + | |||
| + | * [https://gnucash.uservoice.com Uservoice] is an interesting forum for discussion of '''new feature requests''' (but not bug reports). | ||
| + | Usually each (accepted) feature request should get one Bugzilla entry. | ||
| + | * The online banking module '''AqBanking''' has its own [https://git.aqbanking.de/trac/aqbanking/report bugtracker]. | ||
| + | * If '''Finance::Quote''' is not working correctly, you can test it by using the ''gnc-fq-*'' command line tools, see [[FAQ#Q:_How_do_I_fix_a_.22system_error.22_or_.22unknown_error.22_when_getting_stock_quotes.3F|FAQ]]. Use [https://rt.cpan.org/Public/Dist/Display.html?Status=Active&Name=Finance-Quote their Request Tracker] at the Comprehensive Perl Archive Network ([http://www.cpan.org/ CPAN]). | ||
== Commenting on existing bugs or entering new ones == | == Commenting on existing bugs or entering new ones == | ||
| Line 19: | Line 28: | ||
: [http://www.bugzilla.org/docs/3.4/en/html/using.html bugzillas help] has useful information on using Bugzilla. | : [http://www.bugzilla.org/docs/3.4/en/html/using.html bugzillas help] has useful information on using Bugzilla. | ||
| − | |||
| − | |||
;Tip: If you refer to other bugs in your text, we suggest to use the form ''bug nnnnnn - Title''. Bugzilla will then add a link and the reader saves time if the title can be read without following the link. | ;Tip: If you refer to other bugs in your text, we suggest to use the form ''bug nnnnnn - Title''. Bugzilla will then add a link and the reader saves time if the title can be read without following the link. | ||
| − | Do not copy and paste log files. Instead append them as attachments. | + | * Do not copy and paste log files. Instead append them as attachments. |
| − | + | === Attachments === | |
If a program crash or freeze only happens on a specific file (for example, a data file, an import file, or a (modified) report), it can be useful to attach a ''copy'' of that file to your bug report. | If a program crash or freeze only happens on a specific file (for example, a data file, an import file, or a (modified) report), it can be useful to attach a ''copy'' of that file to your bug report. | ||
| Line 32: | Line 39: | ||
When uploading, adjust the mime type of your file. ''Uncompressed'' gnucash data files are of type ''text/xml''. Most import files and log files are of type ''text/plain''. | When uploading, adjust the mime type of your file. ''Uncompressed'' gnucash data files are of type ''text/xml''. Most import files and log files are of type ''text/plain''. | ||
| − | == | + | == Configure Notifications == |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
If you want to receive email notifications about '''a particular bug''', you can add the email address that is ''your Bugzilla id'' to the '''CC''' list on the bug. Bugzilla will do this for you by default if you take any action on the bug page. | If you want to receive email notifications about '''a particular bug''', you can add the email address that is ''your Bugzilla id'' to the '''CC''' list on the bug. Bugzilla will do this for you by default if you take any action on the bug page. | ||
Revision as of 19:13, 26 July 2017
This page describes the normal usage of Bugzilla. For Quality Assurance (QA) tasks see QA/BugzillaAdministration.
Contents
Introduction
If you discover a problem with the program or its documentation (known as a bug), you may want to record the bug so that it can be fixed by the developers. The GnuCash project uses the Bugzilla repository maintained by the Gnome Project. Bugzilla includes bugs and enhancement requests for a wide number of projects, including GnuCash.
Because Gnomes Bugzilla manages bugs for many projects, it can be useful to see only bugs of GnuCash. There is a specific GnuCash "Product" page which allows you to see GnuCash bugs. On this page, you can see the bugs for GnuCash arranged by component. The number of bugs for each component is clickable, and will display the list of the open bugs for that component.
Triage
Before filing a new bug, you should check to see whether the problem or suggestion has already been made. It may be still open or already closed after the date of your release.
Here are several links to different Bugzilla sections:
- Search the entire GNOME bug database (overwhelming)
- Search for open GnuCash bugs and enhancements
- Search for open GnuCash bugs and enhancements, restricted to post-1.8 or unspecified versions
Other Resources
- Uservoice is an interesting forum for discussion of new feature requests (but not bug reports).
Usually each (accepted) feature request should get one Bugzilla entry.
- The online banking module AqBanking has its own bugtracker.
- If Finance::Quote is not working correctly, you can test it by using the gnc-fq-* command line tools, see FAQ. Use their Request Tracker at the Comprehensive Perl Archive Network (CPAN).
Commenting on existing bugs or entering new ones
If a bug has already been entered for the problem or enhancement you have identified, you can add comments to that bug.
If there is no bug, then you can Open a new GnuCash bug or enhancement Request. When reporting a crash, it may be helpful to provide the developers with the stack trace and some of the errors that are generated. See Stack Trace and Tracefile for information on how to produce a stack trace for your bug report, and logging to learn about capturing and providing error messages and filtering detail.
- bugzillas help has useful information on using Bugzilla.
- Tip
- If you refer to other bugs in your text, we suggest to use the form bug nnnnnn - Title. Bugzilla will then add a link and the reader saves time if the title can be read without following the link.
- Do not copy and paste log files. Instead append them as attachments.
Attachments
If a program crash or freeze only happens on a specific file (for example, a data file, an import file, or a (modified) report), it can be useful to attach a copy of that file to your bug report.
If the crash is caused by a data file, you should attach the XML file in uncompressed format (see Edit->Preferences->General->Files->Compress Files). Bear in mind that this data is available on the internet, and take steps to protect your financial data, e.g., by using the ObfuscateScript. If the file is really big, try to create a minimal example.
When uploading, adjust the mime type of your file. Uncompressed gnucash data files are of type text/xml. Most import files and log files are of type text/plain.
Configure Notifications
If you want to receive email notifications about a particular bug, you can add the email address that is your Bugzilla id to the CC list on the bug. Bugzilla will do this for you by default if you take any action on the bug page.
If you want to be notified about all changes to particular categories of bugs, including new ones, add one or more of the following email addresses to your User Watch list in your Bugzilla Email Preferences: After login click the Preferences item in the Bugzilla menu bar and select the Email Preferences tab. The watch list is underneath the table with all of the check boxes. The email addresses and the groups they monitor are:
| Group | Elements |
|---|---|
| gnucash-core-maint@gnome.bugs | Backend-SQL, Backend-XML, Budgets, Build System, Business, Currency and Commodity, Engine, Python Bindings, Scheduled Transactions |
| gnucash-documentation-maint@gnome.bugs | Documentation, Translations, Website |
| gnucash-general-maint@gnome.bugs | General |
| gnucash-import-maint@gnome.bugs | Import-AqBanking, Import-CSV, Import-OFX, Import-Other, Import-QIF, Import-QSF, TXF Export |
| gnucash-mac-maint@gnome.bugs | MacOS |
| gnucash-reports-maint@gnome.bugs | Check Printing, Reports |
| gnucash-ui-maint@gnome.bugs | Register, Regist-2, User Interface General |
| gnucash-win-maint@gnome.bugs | Windows |
For those people who might like to help manage bugs on Bugzilla, there is additional information in QA/BugzillaAdministration.
