Bug triage

From Gramps
Jump to: navigation, search

Help the Gramps project with bug triaging.

Fixing a bug always starts with reproducing it, and many times the developer does not succeed in that. Making that possible is the aim of triage.

The bug/issue tracker for Gramps is located at the following URL: https://gramps-project.org/bugs

Interested in volunteering

Read this page and then contact the Gramps developers mailing list and ask for the ability to change bugs

Goals of Bug Triage


The goal of bug triage is to make it easier for developers to do development by organizing the bug list for them. This means the developers are able to spend less time asking bug reporters what the problem is, confirming if it is still an issue in the latest master branch in Git.

Bug triage includes the reduction of open tickets, removal of stale/out of date tickets, and grouping of feature requests.


MantisBT valid Status states.
* "new"
* "feedback"
* "acknowledged"
* "confirmed"
* "assigned"
* "closed"
* "resolved"

Make sure you're using the current 5.2.0 release of Gramps, using the master branch in Git is usually best. From a clean install of Gramps attempt to reproduce the bug that is being reported. If you cannot reproduce the bug, post a comment as such - explaining the steps you took to reproduce the bug. If you encounter a different bug, file a new bug report for that problem if one has not been filed already.

  • Make sure you have Gramps installed so you can test bugs and problems. Create a family tree and import the example.gramps file.

It would be beneficial to also run the master branch version of Gramps so as to test bugs that are in the master branch only.

  • At the moment only projects Gramps 5.0, Gramps 5.1 and Gramps master are supported, so any bugs not closed or resolved in older versions must be resolved one way or the other:
    • "resolved" in the meantime
    • does not apply anymore, state why and change the status to "closed"
    • version no longer supported (EOL versions), backup your family trees and install and try with the new version
    • bug/problem still present, or move the bug to the correct project eg decide if it is a feature request?
    • too little information given, "feedback" wanted from reporter
    • several issues in one bug, close it asking users to submit a single ticket per issue (or rename the bug for one issue, and ask to create new ones for the other),
    • other issues...

be polite when responding to a bug ticket.

  • For the supported projects, the bugs must be triaged: Duplicate bugs "closed", set a better bug title so it is more clear for a developer what the bug is about, add extra information. Most important here is to try to duplicate the bug with the example.gramps file, as that is what the developer will spend a lot of time trying to do. Fixing a bug always starts with reproducing it, and many times the developer does not succeed in that. Making that possible is the aim of triage. Once a developer sees a bug in front of him, fixing it is often easier.
  • Then there is the feature request project. These must be organised somehow. It is best you look at some of those tickets and make a suggestion on how to organize it so that the feature requests remain useful. Also giving better titles is important here, closing duplicates. Don't be afraid to close something saying users must give a better worked out request (but be polite!).
  • Don't leave bugs in "new" state if they're actually no longer new.
  • Bugs that are clearly not spam, and have enough info to start an investigation (even though they might turn out as a problem at submitter's end) should be made "acknowledged".
  • Those that other people are able to reproduce (or reason about their validity) should be "confirmed".
    • If a feature request is valid also move it to "confirmed". This only confirms it's a possibility and is not a guarantee that the Gramps project will develop and include it in a future release.
  • If the bug is blocked waiting for somebody's input, mark it as "feedback".
  • If somebody is actively working on a bug, this is best expressed as "assigned". If you stop working on a bug, please remove it from assigned state.

Resolving bugs for developers

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

The Roadmappage of the bug tracker lists the bugs currently prioritized for the next releases. If you are looking for a bug to fix, this is a good place to start. Placement on the roadmap is controlled by the "Target Version" field for the bug. Special "X.Y.99" phony releases, such as "3.4.99" and "4.0.99", list bugs that we would eventually like to fix for the "X.Y" version, but don't really know the milestone yet. Bugs that really should hold up a release should be on the roadmap with a real release number, and should only be moved after giving a reason or heads up on the devel list [1]. If you fix a bug scheduled for a later milestone before a previous one is out, please manually adjust the target release field before marking the bug resolved, otherwise the roadmap display will be inaccurate [2].

In general, when resolving an issue, it is always a good idea to add a note with the “commit hash” (also called the Git commit “reference” or “SHA”) 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 Change Log page for that project.

Bugs in maintenance branch projects should not be marked as "resolved" 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 the master branch.

MantisBT permissions

If you don't have MantisBT permissions (the ability to change bugs' status from "new" to "feedback", "acknowledged","confirmed", "closed" or "resolved"), then feel free to ask on the gramps-devel mailing list for someone to set the status for you (eg: "Could someone set bug #1 to "closed" please?). Once you do this enough, feel free to ask for MantisBT permissions on the same mailing list.


See the summary page:


Sometime in the past 4495 issues disappeared during a mantisdb upgrade, to which a number of existing issues keep referring to.

See also