Reporting Issues

This article discusses the process of reporting bugs, feature requests, etc.

Tickets

Each bug, feature request, etc. should be submitted as a "ticket". A ticket provides a summary and a description of the issue, other information such as version, component and priority, the status of the issue (i.e. whether it is new, has been resolved, etc.), and comments about the issue. This allows the project team and other users to keep track of reported issues. You and other interested users can be notified of changes to the ticket; e.g. you will be notified if it is fixed. For more information about tickets, see TracTickets.

Before Creating a Ticket

Before opening a new ticket, please first search existing tickets to determine whether the issue has already been reported. You can also perform more specific queries on tickets by using the View Tickets link in the navigation bar.

To create and edit tickets, you need to register an account or log in if you already have an account.

Creating a New Ticket

To create a new ticket:

  1. Select the New Ticket link in the navigation bar.
  2. Fill in the fields in the new ticket form. The main fields are described below.
    • Summary: Provide a brief summary of the issue. This should identify the issue as clearly as possible.
    • Description: Provide a thorough description of the issue. If you are reporting a bug, you should describe how often the problem occurs, detailed steps to reproduce the problem, the results you expected and the actual results. Include any additional information that might be relevant.
    • Type: This is the type of the issue; i.e. defect (bug), enhancement or task.
    • Priority: This indicates the importance of the issue.
    • Milestone: This specifies in what version of NVDA the issue should be resolved. This should normally be left blank, as the developers will determine when an issue should be resolved.
    • Component: This specifies the component/area of NVDA to which the issue is related.
    • Version: This specifies the version of NVDA in which the issue occurred or to which it is relevant. Select "trunk" if you are running a trunk snapshot. Please note that issues relating to NVDA 0.5 will not be considered, so please do not open tickets for them.
    • You do not need to fill in any of the other fields.
    • You may also attach files to the ticket if appropriate; e.g. log files or patches.

Editing Tickets

You can edit information about or add a comment to a ticket. Simply view the ticket you wish to edit and change the appropriate fields on the form.