Issues

On this page, you can report and browse bugs, feature requests, etc. Please note that except for the OCR add-on, issues concerning specific add-ons or requests for new add-ons should not be reported here.

What would you like to do?

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.

A ticket should only cover one single issue. Please do not file a single ticket covering multiple issues. Instead, file separate tickets for each issue.

Before Creating a Ticket

Before opening a new ticket, please first search existing tickets to determine whether the issue has already been reported.

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. Go to the new ticket form. (A link to this form is also provided at the top of this page.)
  2. Fill in the fields in the new ticket form. The main fields are described below.
  3. You may also attach files to the ticket if appropriate; e.g. log files, crash dumps or patches.
  4. Press the "Create ticket" button.

Ticket Fields

These are the basic fields:

  • Summary: A short sentence or phrase briefly summarising the issue. This should identify the issue as clearly as possible.
  • Description: 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.
    • If you are requesting a feature or improvement, please include use cases; i.e. information about how it will be used and by whom.
  • Type: The type of the issue:
    • defect: A bug, unexpected behaviour, etc.
    • enhancement: A feature or improvement request.
    • task: Rarely used, and even then, usually only by developers. Something which needs to be done but does not fit the other types.
  • Component: The component/area of NVDA to which the issue is related. See TicketComponents for explanations of the components.
  • Version: The version of NVDA in which the issue occurred or to which it is relevant. Select "master" or "next" if you are running a master or next development snapshot, respectively. Please note that issues relating to old releases will not be considered, so please do not open tickets for them.
  • Operating system: The operating system on which the issue occurs. Only specify this if the issue is specific to that operating system.

There are also some other advanced fields which can be seen by all users but can only be changed by developers:

  • Priority: The importance of the issue.
  • Milestone: The version of NVDA in which the issue should be resolved.
  • Keywords: A space separated list of keywords which provide other meta information about the ticket. See TicketKeywords for a list of commonly used keywords.
  • Blocked by: A comma separated list of ticket numbers which block this ticket; i.e. tickets that this ticket depends on.
  • Blocking: A comma separated list of ticket numbers which this ticket is blocking; i.e. tickets that depend on this ticket.

Editing Tickets

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

Providing Log Files and Crash Dumps

Log files and crash dumps are often useful, if not essential, when tracking down a problem. See Log Files and Crash Dumps for information about how to obtain these.

Ticket Status

As a ticket is addressed, its status will be changed accordingly. The possible statuses are as follows:

  • new: The initial state of a ticket. At this point, no definite action has been taken.
  • assigned: The ticket has been assigned to someone for future work, but the assignee has not yet started work on the ticket.
  • accepted: The assignee has accepted the ticket and is now working on it.
  • incubating: The relevant change is available for testing in the "next" branch. See ReleaseProcess for details.
  • closed: The ticket has been resolved in some way. It might be fixed or it might have been determined that it should not be fixed, is a duplicate of another ticket, etc.
  • reopened: The ticket has been reopened after being closed. For example, it might have been determined that the fix was incorrect.
  • abandoned: The person assigned this ticket has abandoned work on it and no one else is able or willing to continue the work. If someone is able to continue the work in future, it can be assigned to that person.