Difference between revisions of "Bugzilla"
m (Remove QA/) |
(→Updating content to remove outdated information on the Bugzilla transition) |
||
| Line 1: | Line 1: | ||
This page describes the normal usage of Bugzilla. For Quality Assurance (QA) tasks see [[Bugzilla Administration]]. | This page describes the normal usage of Bugzilla. For Quality Assurance (QA) tasks see [[Bugzilla Administration]]. | ||
| − | ''' | + | '''NOTE:''' In 2018, Gnome Bugzilla shut down, and GnuCash implemented its own [https://bugs.gnucash.org Bugzilla]. All GnuCash bugs should now be reported there. Gnome's instance continues to run, but is closed for further additions. All bugs on Gnome's Bugzilla refer visitors to GnuCash's Bugzilla. |
| − | |||
| − | |||
== Introduction == | == Introduction == | ||
| − | If you discover a problem with the program or its documentation (known as a ''bug''), you | + | If you discover a problem with the program or its documentation (known as a ''bug''), you should record the bug so that it can be fixed by the developers. The GnuCash project uses the [http://bugs.gnucash.org/ Bugzilla] repository, which includes ''bugs'' and ''enhancement requests'' for GnuCash. Tips for submitting enhancement requests can be found at [[Enhancement requests]]. |
| − | |||
| − | |||
== Triage == | == Triage == | ||
| Line 19: | Line 15: | ||
* [{{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] | * [{{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] | ||
| − | + | ''Note:'' 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]. | |
| − | + | * '''AqBanking''' has its own [https://git.aquamaniac.de/trac/aqbanking/report bugtracker]. | |
| − | + | * '''Finance::Quote''' can be tested 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]). | ::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]). | ||
| Line 33: | Line 25: | ||
If a bug has already been entered for the problem or enhancement you have identified, you can add comments to that bug. | 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:// | + | If there is no bug, then you can [http://bugs.gnucash.org/enter_bug.cgi?product=GnuCash Open a new GnuCash bug]. |
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. | 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. | ||
Revision as of 08:45, 3 February 2019
This page describes the normal usage of Bugzilla. For Quality Assurance (QA) tasks see Bugzilla Administration.
NOTE: In 2018, Gnome Bugzilla shut down, and GnuCash implemented its own Bugzilla. All GnuCash bugs should now be reported there. Gnome's instance continues to run, but is closed for further additions. All bugs on Gnome's Bugzilla refer visitors to GnuCash's Bugzilla.
Contents
Introduction
If you discover a problem with the program or its documentation (known as a bug), you should record the bug so that it can be fixed by the developers. The GnuCash project uses the Bugzilla repository, which includes bugs and enhancement requests for GnuCash. Tips for submitting enhancement requests can be found at Enhancement requests.
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 bug database Use the Basic tab for a very simple search or the Advanced tab to search on just about anything.
- Search for open GnuCash bugs and enhancements
- Search for open GnuCash bugs and enhancements, restricted to versions 3.0, 3.1, and 3.2
Note: Third party components have their own bug trackers:
- GnuCash for Android: Beneath GitHub issues see also support group and feature requests.
- AqBanking has its own bugtracker.
- Finance::Quote can be tested 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.
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.
