Using Trac With QGIS

This page summarizes how to use Trac with QGIS and provides links to specific information about features and operating procedures.

Login

Its important to login if you are a developer or intend to contribute code in the form of patches. If you just want to submit a bug you don't need an account. Use ​https://svn.qgis.org/trac/login to login (https is required).

Email Notification

If you want notification of all issues and project events, subscribe to the Qgis-trac mailing list at

​http://lists.qgis.org/cgi-bin/mailman/listinfo/qgis-trac.

You can set your options to digest if you find the amount of email per day to be too large.

Tickets

Tickets are used to report bugs, request enhancments, and assign tasks. Trac is more than a bug reporting system. Tickets can be associated with a ​QGIS Milestone, allowing you to see progress towards completion. Completion of a Milestone not only requires closing bugs, but completing other tasks releated to a release such as documentation, web site updates, packaging, and announcements.

Opening a Ticket

Before filing a bug, review the currently open tickets to make sure that you aren't creating a duplicate. If you have additional information on an issue, you can add it to the ticket.

To report a bug choose New Ticket from the menu bar. Note: You can also report a defect, request an enhancement, create a task, or submit a patch using the Ticket system.

Important information needed when opening a ticket:

• Your email or username - If you have a login your user name will be automatically supplied. If not, please provide your email address so we can contact you for further information and follow-ups.
• Type - choose the ticket type from the drop-down list
  • defect - cosmetic problem
  • enhancement - feature request
  • task - task (Trac allows management of tasks as well as bugs)
  • bug - bug
  • patch - patch (see patch notes below)
• Full description - Provide a full description of the problem including steps to repeat it
• Priority - provide an estimate of the severity of the problem
• Component - Choose the aspect of the application that is most closely associated with the problem
• Milestone - If this issue affects a particular Milestone in the project choose it from the drop-down list
• Version of QGIS this issue affects
• Platform - Choose the platform you are using
• Platform Version - provide the version of your platform. This may be a number or name. Here are some examples of Platform and Platform version pairs, separated by a dash:
  • Debian - Sarge
  • OS X - 10.4
  • Windows - XP
  • Fedora - Core 5

Color Coding

The background color of a ticket (bug, enchancement, etc) is color coded in reports by Priority:

• blocker
• critical
• major
• minor
• trivial
• closed

Creating a patch

Assuming you have checked out your svn copy into a directory called 'qgis', create your patch from in the top level directory of the cvs checkout e.g.

cd qgis
svn diff > patch_for_bug_33.txt

Note the naming convention - include the id of the bug you are fixing with your patch.

Closing a ticket

When committing a bug fix to the Subversion repository, refer to the bug number preceded by # as follows:

Fix for bug #31 using patch provided by Joe Bloggs

When closing the bug in trac refer to the Subversion version number of that commit:

This issue is fixed in r5051

If you follow this approach, your bug will be cross-linked in both ticket view and the source browsing view.