Difference between revisions of "Bugzilla"

From GnuCash
Jump to: navigation, search
(attach a file to your bug report; some structuring)
(Other Resources - Add link for gnc-fq FAQ)
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[http://bugzilla.gnome.org/ Bugzilla] is a repository of bugs and enhancement requests maintained by the [http://www.gnome.org/ Gnome Project] and used by the GnuCash project.
+
[http://bugzilla.gnome.org/ Bugzilla] is a repository of ''bugs'' and ''enhancement requests'' maintained by the [http://www.gnome.org/ Gnome Project] and used by the GnuCash project.
  
= Other Resources =
+
== Other Resources ==
  
 
* Also, [https://gnucash.uservoice.com uservoice.com] is an interesting forum for discussion of '''new feature requests''' (but not bug reports).
 
* Also, [https://gnucash.uservoice.com uservoice.com] is an interesting forum for discussion of '''new feature requests''' (but not bug reports).
 +
* 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]).
  
= Using Bugzilla =
+
== Using Bugzilla ==
There is a specific GnuCash "product" subsection which allows you to specifically search for GnuCash bugs. You can use the following quick links to perform actions on the GnuCash Bugs Database:
+
There is a specific [https://bugzilla.gnome.org/browse.cgi?product=GnuCash GnuCash "Product" page] which inter alia allows you to specifically search for GnuCash bugs. E.g. can you there click number right of the interesting component and will get the list of the open bugs.
  
Strongly recommended:
+
=== Bug Mail ===
 +
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 Bugzilla Email Preferences: 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:
 +
{| Border="0"
 +
! width="180" | Group !! width="500" | 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
 +
|}
  
* [https://bugzilla.gnome.org/browse.cgi?product=GnuCash GnuCash bug overview]
+
=== Triage ===
 +
At first you should check for existing reports of the same problem or improvement suggestion. It may be ''still'' '''open''' or ''already'' '''closed''' after the date of your release.
  
Other links into bugzilla:
+
Example links into GnuCash's bugzilla section:
 
 
* [http://bugzilla.gnome.org/query.cgi Search the entire GNOME bug database]
 
* [http://bugzilla.gnome.org/buglist.cgi?product=GnuCash&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&bug_status=VERIFIED&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&bug_status=VERIFIED&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/query.cgi Search the entire GNOME bug database] (overwhelming)
 +
* [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]
  
 +
=== Entering of or commenting on bugs ===
 
: You might probably read the [[FAQ#Q:_What_should_I_obey_as_a_beginner_in_bug_reporting.2C_enhacement_requesting_....3F | FAQ section about bug reporting]] before you continue ...
 
: You might probably read the [[FAQ#Q:_What_should_I_obey_as_a_beginner_in_bug_reporting.2C_enhacement_requesting_....3F | FAQ section about bug reporting]] before you continue ...
 
: Also [http://www.bugzilla.org/docs/3.4/en/html/using.html bugzillas help] has useful parts.
 
: Also [http://www.bugzilla.org/docs/3.4/en/html/using.html bugzillas help] has useful parts.
  
 
* [http://bugzilla.gnome.org/enter_bug.cgi?product=GnuCash Open a new GnuCash bug or enhancement Request]; when reporting a crash, see [[Stack Trace]] and [[Tracefile]] for information on how to produce a stack trace for your bug report.
 
* [http://bugzilla.gnome.org/enter_bug.cgi?product=GnuCash Open a new GnuCash bug or enhancement Request]; when reporting a crash, see [[Stack Trace]] and [[Tracefile]] for information on how to produce a stack trace for your bug report.
 
+
;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 ====
 
If a program crash or freeze only happens on a specific file like
 
If a program crash or freeze only happens on a specific file like
 
* data file
 
* data file
 
* import file
 
* import file
 
* (modified) report
 
* (modified) report
it can be useful to attach a copy of that file to your bug report.  
+
it can be useful to attach a ''copy'' of that file to your bug report, but:
* If the file contains confidential data do not forget to anonymize you data.
+
* It is easier, if you attach your XML data file ''uncompressed''. Before you save your file, uncheck <tt>Edit->Preferences->General->Files->Compress Files</tt>. It can then already be seen in the web interface.
 +
* If the file contains confidential data do not forget to anonymize your data e.g. with the [[ObfuscateScript]].
 
* If the file is really big, try to create a minimal example.
 
* If the file is really big, try to create a minimal example.
 
When uploading adjust the mime type of your file:
 
When uploading adjust the mime type of your file:
 
* ''Uncompressed'' gnucash data files are of type ''text/xml'',
 
* ''Uncompressed'' gnucash data files are of type ''text/xml'',
* most import files are of type ''text/plain''.
+
* most import files and log files are of type ''text/plain''.
 
 
If a developer asked you for some information or one of the files above and you attached them, do not forget, to reset the bug status from ''needinfo'' to ''unconfirmed'' again.
 
 
 
= Bug Triage =
 
For people, which like to help us e.g. on bug triage, are some additional informations in [[QA/BugzillaAdministration]] and .
 
 
 
== Stock messages ==
 
Feel free to copy this messages into the comment when closing bugs for certain reasons that occur regularly.
 
 
 
=== When closing an old bug as OBSOLETE ===
 
Thank you for taking the time to report this bug.
 
However, you are using a version that is too old and not supported anymore. The GnuCash developers are no longer working on that version, so either this bug has already been fixed or unfortunately there will not be any bug fixes for the version that you use. The current stable version of gnucash is 2.4.0 now.
 
 
 
In the (hopefully unlikely) case you discover the same bug in the very latest stable version, do not hesitate to REOPEN it again. Also, feel free to file other bugs or enhancement requests that you find. Thank you very much!
 
 
 
=== When refusing an enhancement request as WONTFIX or priority=low ===
 
Thank you for taking the time to explain your enhancement request.
 
 
 
The described enhancement is a good proposal and would be an advantage for the software. However, as a volunteer-driven project with limited resources, the GnuCash developers have their own priorities about the features which are most likely being worked on in the near future. In that sense, the current GnuCash developers decided not to work on your proposed feature in the next 4-6 months. In case you would like to have this feature implemented in any case, you have the following option: 1. Start to program in gnucash yourself - see http://wiki.gnucash.org/wiki/Development . 2. Convince someone who is not yet part of the GnuCash team to join the team and implement your feature. 3. Pay some of the GnuCash developers to implement your feature - ask on the mailing list gnucash-devel@gnucash.org in that case. Thank you very much.
 
  
Feel free to file other bugs or enhancement requests that you find, though.
+
==== Answers ====
 +
If a developer asked you for some information or one of the files above and you attached them, do not forget, to '''reset the bug status''' from ''needinfo'' to ''unconfirmed'' again.
  
=== For explaining why we ask questions even though the original report might be very old ===
+
== Bug Triage ==
Thanks a lot for your feedback. You are right, it was not nice from gnucash to not reply to your initial report for quite some time. We are very sorry for that. However, at the sporadic occasions when some of us check *all* currently open bugreports (even though this part of gnucash used to be in someone else's responsibility) we only have the choice to either continue not to reply, or add a reply even though the original report is already several months old (or years). In your case, we have decided it is better to reply late than not to reply at all. Thank you very much for bearing the imponderables of a large volunteer project such as ours.
+
For those people who may like to help us e.g. on bug triage, there is some additional information in [[QA/BugzillaAdministration]].

Revision as of 23:28, 17 March 2017

Bugzilla is a repository of bugs and enhancement requests maintained by the Gnome Project and used by the GnuCash project.

Other Resources

  • Also, uservoice.com is an interesting forum for discussion of new feature requests (but not bug reports).
  • 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).

Using Bugzilla

There is a specific GnuCash "Product" page which inter alia allows you to specifically search for GnuCash bugs. E.g. can you there click number right of the interesting component and will get the list of the open bugs.

Bug Mail

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 Bugzilla Email Preferences: 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

Triage

At first you should check for existing reports of the same problem or improvement suggestion. It may be still open or already closed after the date of your release.

Example links into GnuCash's bugzilla section:

Entering of or commenting on bugs

You might probably read the FAQ section about bug reporting before you continue ...
Also bugzillas help has useful parts.
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

If a program crash or freeze only happens on a specific file like

  • data file
  • import file
  • (modified) report

it can be useful to attach a copy of that file to your bug report, but:

  • It is easier, if you attach your XML data file uncompressed. Before you save your file, uncheck Edit->Preferences->General->Files->Compress Files. It can then already be seen in the web interface.
  • If the file contains confidential data do not forget to anonymize your data e.g. with 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.

Answers

If a developer asked you for some information or one of the files above and you attached them, do not forget, to reset the bug status from needinfo to unconfirmed again.

Bug Triage

For those people who may like to help us e.g. on bug triage, there is some additional information in QA/BugzillaAdministration.