Difference between revisions of "Using the bug tracker"

From Gramps
Jump to: navigation, search
m (How to proceed: update example)
Line 1: Line 1:
 
{{languages}}
 
{{languages}}
The issue tracker for GRAMPS is located here: http://bugs.gramps-project.org. It allows users and developers to log new issues and track them as they progress. Please take some time to read the issue tracker instructions below and read [[How to create a good bug report|how to create a good bug report]].
+
The issue tracker for GRAMPS is located here: http://bugs.gramps-project.org. It allows users and developers to log new issues and track them as they progress. Please take some time to read the issue tracker instructions below and read [[How to create a good bug report|how to create a good bug report]]. Also, have a look at [[Known_issues|know issues]].
  
 
==Report a Bug==
 
==Report a Bug==

Revision as of 01:41, 29 June 2009

The issue tracker for GRAMPS is located here: http://bugs.gramps-project.org. It allows users and developers to log new issues and track them as they progress. Please take some time to read the issue tracker instructions below and read how to create a good bug report. Also, have a look at know issues.

Report a Bug

1. Login

To report a bug, you must have a login account on http://bugs.gramps-project.org, which is the GRAMPS bug tracker. If you create a user account, remember that it can take up to 12 hours before a notification email is send to you. Only after clicking on the link in the email can you submit bugs. Your email will be handled confidentially.

2. Search existing bugs

Perhaps the bug you found has been submitted before. To check this, click on 'View Issues'. The top of the page is reserved to filters, which you set. Normally the default is just fine. Under these filters, there is a search box. Enter the terms best describing the bug, and click apply filter. If you have an error message, try pasting a part of the error, to see if it is logged already.

If the bug is already reported, read the report over, and see if you can add to the information. If so, you can leave a note with extra information to help the developers.

3. Submit new bug

Click on Report Issue, and enter the required information, see below on how to select the project to which the bug belongs. Be verbose, the developers are bad at mind reading. Do not forget to list the GRAMPS version you are using. You can check this in GRAMPS by clicking in the GRAMPS program the Help menu, option About.

Projects

In the upper right corner of the issue tracker, there is a place to select the "project" for the bugs. "Projects" are a way to categorize issues. There are three types of projects in the issue tracker:

  1. The Feature Requests project is a place for recording requests for new features.
  2. The projects with names that look like Gramps x.x.X is where issues are reported that apply specifically to a maintenance branch (see Types of Branches). A separate project exists for each maintenance branch.
  3. The Gramps Trunk project should only be used by developers and testers of the latest code. It is a place for recording issues that only apply to the trunk in Subversion (see Types of Branches). There is only one "Gramps Trunk" project because there is only one trunk in the Subversion repository

How to proceed

The first step in submitting an issue on the tracker is to determine which project it belongs to.

  • If the issue represents functionality that does not currently exist in GRAMPS, then the issue should be filed under the Feature Requests project.
  • If the issue represents a problem with functionality that has been released in a stable release of code, then the issue should be filed under the project that corresponds to the maintenance branch for that release. For example, a bug found in GRAMPS 3.1.2 should be filed under the Gramps 3.1.X project.
  • If the issue represents a problem with functionality that only exists in trunk, or the problem exists in trunk, but not any stable releases, then the issue should be filed under the Gramps Trunk project.

Resolving Bugs

This information is for the developers following up on the submitted issues.

In general, when resolving an issue, it is always a good idea to add a note with the SVN revision number of the commit that fixed the problem.

When resolving issues in a maintenance branch, one should always set the "Fixed in version" field to the version of the next release that will be made from that branch. This is done so that the issue properly appears in the ChangeLog page for that project (http://bugs.gramps-project.org/changelog_page.php).

Bugs in maintenance branch projects should not be marked as closed until the developer has committed the change into the corresponding maintenance branch. Additionally, it is the developers responsibility to make sure the change has been merged into trunk.