Difference between revisions of "Bugzilla"

From GnuCash
Jump to: navigation, search
m (Entering of or commenting on bugs - grammar fix)
m (Remove QA/)
(26 intermediate revisions by 3 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.
+
This page describes the normal usage of Bugzilla. For Quality Assurance (QA) tasks see [[Bugzilla Administration]].
  
== Other Resources ==
+
'''NOTICE:''' Gnome is shutting down creating new bugs in [https://bugzilla.gnome.org their Bugzilla] on 1 July so GnuCash will migrate its bugs to a new self-hosted instance at https://bugs.gnucash.org at 2018-06-29 20:00:00 UTC (that's Friday 29 June 22:00 Europe, 16:00 US Eastern, and Saturday, 30 June 04:00 Western Australia). All open GnuCash bugs on [https://bugzilla.gnome.org Gnome Bugzilla] will be closed RESOLVED OBSOLETE at that time and all bugs, open or closed, will get a comment with the new URL for that bug. We will disable creating new bugs before beginning the final migration and enable creating bugs on [https://bugs.gnucash.org GnuCash's Bugzilla] when it's complete. We expect the migration to take less than two hours.
  
* Also, [https://gnucash.uservoice.com uservoice.com] is an interesting forum for discussion of '''new feature requests''' (but not bug reports).
+
User accounts and email addresses will be migrated but passwords and email "watch" lists will not. Existing users will have to reset their passwords after migration is complete using the "Forgot Password" link at the top of the page. Watch lists (to get the same bug-mail as other users including the "pseudo-users", see below, will need to be recreated on the Email Preferences tab in Preferences reachable by selecting Preferences at the top of any page after login.
* The online banking module '''AqBanking''' has it's 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]).
 
  
== Using Bugzilla ==
+
== Introduction ==
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.
+
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.  
  
=== Triage ===
+
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.
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:
+
== 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.
  
* [http://bugzilla.gnome.org/query.cgi Search the entire GNOME bug database] (overwhelming)
+
Here are several links to different Bugzilla sections:
* [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 ===
+
* [{{BugURL}}/query.cgi Search the entire bug database] Use the Basic tab for a very simple search or the Advanced tab to search on just about anything.
: You should 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 ...
+
* [{{BugURL}}/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]
: Also [http://www.bugzilla.org/docs/3.4/en/html/using.html bugzillas help] has useful parts.
+
* [{{BugURL}}/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=3.0&version=3.1&version=3.2 Search for open GnuCash bugs and enhancements, restricted to versions 3.0, 3.1, and 3.2]
 +
 
 +
=== 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.
 +
* Third party components have their own bug trackers:
 +
** '''[https://github.com/codinguser/gnucash-android GnuCash for Android]''': Beneath [https://github.com/codinguser/gnucash-android/issues?q=is%3Aopen GitHub issues] see also [https://plus.google.com/communities/104728406764752407046 support group] and [https://gnucash.uservoice.com/forums/320493-gnucash-android feature requests].
 +
** The online banking module '''AqBanking''' has its own [https://git.aquamaniac.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 ==
 +
 
 +
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 [http://bugzilla.gnome.org/enter_bug.cgi?product=GnuCash 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.
 +
 
 +
For documentation bugs, most commonly use '''git-maint''' in the version field, which is used to update the documentation on existing GnuCash features. If you are documenting a new feature (for example, a feature only in a future stable release), use '''git-master'''. See [[Git#Branches|Git - Branches]] for more on this.
 +
 
 +
: [http://www.bugzilla.org/docs/3.4/en/html/using.html bugzillas help] has useful information on using Bugzilla.
  
* [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.
 
;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 <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.
 
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 ====
+
* Do not copy and paste log files. Instead append them as attachments.
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.
+
=== 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 <tt>Edit->Preferences->General->Files->Compress Files</tt>). 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''.
  
=== Bug Mail ===
+
== 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 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:
+
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 [https://bugzilla.gnome.org/userprefs.cgi?tab=email 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"
 
{| Border="0"
! width="180" | Group !! width="500" | Elements  
+
! width="25%" | Group !! width="75%" | Elements  
 +
|-
 +
| core@gnucash.bugs || Backend-SQL, Backend-XML, Budgets, Build System, Business, Currency and Commodity, Engine, Python Bindings, Scheduled Transactions
 
|-
 
|-
| gnucash-core-maint@gnome.bugs || Backend-SQL, Backend-XML, Budgets, Build System, Business, Currency and Commodity, Engine, Python Bindings, Scheduled Transactions
+
| documentation@gnucash.bugs || Documentation, Translations, Website
 
|-
 
|-
| gnucash-documentation-maint@gnome.bugs || Documentation, Translations, Website
+
| general@gnucash.bugs || General
 
|-
 
|-
| gnucash-general-maint@gnome.bugs || General
+
| import@gnome.bugs || Import-AqBanking, Import-CSV, Import-OFX, Import-Other, Import-QIF, Import-QSF, TXF Export
 
|-
 
|-
|| gnucash-import-maint@gnome.bugs || Import-AqBanking, Import-CSV, Import-OFX, Import-Other, Import-QIF, Import-QSF, TXF Export
+
| macos@gnucash.bugs || MacOS
 
|-
 
|-
| gnucash-mac-maint@gnome.bugs || MacOS
+
| reports@gnucash.bugs || Check Printing, Reports
 
|-
 
|-
| gnucash-reports-maint@gnome.bugs || Check Printing, Reports
+
| ui@gnucash.bugs || Register, Regist-2, User Interface General
 
|-
 
|-
| gnucash-ui-maint@gnome.bugs || Register, Regist-2, User Interface General
+
| windows@gnucash.bugs || Windows
 
|-
 
|-
| gnucash-win-maint@gnome.bugs || Windows
+
| all-bugs@gnucash.bugs || Everything
 
|}
 
|}
  
== Bug Triage ==
+
== Help Wanted ==
For those people who may like to help us e.g. on bug triage, there is some additional information in [[QA/BugzillaAdministration]].
+
For those people who might like to help manage bugs on Bugzilla, there is additional information in [[Bugzilla Administration]].

Revision as of 00:25, 3 September 2018

This page describes the normal usage of Bugzilla. For Quality Assurance (QA) tasks see Bugzilla Administration.

NOTICE: Gnome is shutting down creating new bugs in their Bugzilla on 1 July so GnuCash will migrate its bugs to a new self-hosted instance at https://bugs.gnucash.org at 2018-06-29 20:00:00 UTC (that's Friday 29 June 22:00 Europe, 16:00 US Eastern, and Saturday, 30 June 04:00 Western Australia). All open GnuCash bugs on Gnome Bugzilla will be closed RESOLVED OBSOLETE at that time and all bugs, open or closed, will get a comment with the new URL for that bug. We will disable creating new bugs before beginning the final migration and enable creating bugs on GnuCash's Bugzilla when it's complete. We expect the migration to take less than two hours.

User accounts and email addresses will be migrated but passwords and email "watch" lists will not. Existing users will have to reset their passwords after migration is complete using the "Forgot Password" link at the top of the page. Watch lists (to get the same bug-mail as other users including the "pseudo-users", see below, will need to be recreated on the Email Preferences tab in Preferences reachable by selecting Preferences at the top of any page after login.

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:

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.
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.

For documentation bugs, most commonly use git-maint in the version field, which is used to update the documentation on existing GnuCash features. If you are documenting a new feature (for example, a feature only in a future stable release), use git-master. See Git - Branches for more on this.

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
core@gnucash.bugs Backend-SQL, Backend-XML, Budgets, Build System, Business, Currency and Commodity, Engine, Python Bindings, Scheduled Transactions
documentation@gnucash.bugs Documentation, Translations, Website
general@gnucash.bugs General
import@gnome.bugs Import-AqBanking, Import-CSV, Import-OFX, Import-Other, Import-QIF, Import-QSF, TXF Export
macos@gnucash.bugs MacOS
reports@gnucash.bugs Check Printing, Reports
ui@gnucash.bugs Register, Regist-2, User Interface General
windows@gnucash.bugs Windows
all-bugs@gnucash.bugs Everything

Help Wanted

For those people who might like to help manage bugs on Bugzilla, there is additional information in Bugzilla Administration.