The basics of making a ticket for NVACCESS

From time to time you might need to report a bug so that it can be fixed. Before you report the bug, ask others on the list if they are getting the same results as you. NVACCESS will need as much information as possible so they can fix the problem.

Where to go to report a bug to be fixed

If you are a user of the NVDA screen reader (whether you use the Alpha snapshot, Alpha code, the Beta snapshot code or the stable version of NVDA that is released to the public); if you come across a bug, it can be reported at the following webpage https://github.com/nvaccess/nvda/issues

If you want to test either the alpha snapshots or the beta snapshots, you can download them from the following link at https://www.nvaccess.org/files/nvda/snapshots/

If you find any bugs in the snapshots, a ticket can be made and reported - to be fixed by NVACESS.

Getting a GitHub account or simply signing in

To report any issues to be fixed, you must have a GitHub account.

If you do not have a GitHub account, you will need to go to the sign up link, then press the Enter key. It will ask you for a user name, email address and password. Once done, locate the create an account button, then press the Spacebar or Enter key for it to be created.

If you already have an account, it is just a matter of locating the sign in link and entering your details to log into GitHub.

After you have signed into GitHub

After you have signed into GitHub to report an issue on your page, you will have some links and buttons and headings. Do not worry about most of them. The first button is a search button, the second is a create new button, the third a view profile and more button, and a sign out button. You will need to look for a new issue button. This is found under the sign out button; then press the Enter key so a ticket can be created.

Before reporting a new issue, you should do a search to see if a ticket has already been made. If this is the case, you might be able to reply on another ticket if it matches the problems that you are having.  If one cannot be found, then you would create a new issue.

Searching for an issue on GitHub

Before you report an issue/bug to NVACCESS, you will need to do a search to see if anyone else has reported the bug. If one cannot be found then you will need to open a new issue. This is a button. Press the Enter key to do this.

A more direct link to make a ticket

If you have already signed up to GitHub, a more direct link to where you can make a ticket can be found at https://github.com/nvaccess/nvda/issues/new

You can arrow through the page to see all the sections.

As you go down the page, you will hear the following:

This will depend on if you arrow down the page or jump down by buttons. If you jump down by buttons, you will hear the following: (add header text button, add bold text button, add italic text button, insert a quote button, insert code button, add a link button, add a bulleted list button, add a numbered list button, add a task list button, insert a reply button, directly mention a user or team, reference an issue or pull request, browse button, and a submit new issue button).

In most cases, you will not be: inserting a reply (unless you are commenting on a ticket); using directly mention a user or team; or reference an issue or pull request (unless you are replying to a ticket).

You may find it easier to arrow through, rather than use single letter navigation keys to get all of the information.

Single letter navigation keys that can be used in browse mode

You can use B for buttons, K for links, E for edit areas and F for form fields.

They will need to know in the header and text edit area, what the issue is

For example

Steps to reproduce:

A list of the steps you take to demonstrate the problem.

Example:

1. Open Chrome

2. Browse to www.google.com

3. Type "Hello"

4. Notice an error sound when enter is pressed.

Please also remember to attach a zip of any files required to reproduce the issue.


Expected behavior:

Tell us what should happen.

 

Actual behavior:

Tell us what happens instead.

They will also need to know the NVDA version number, and whether it is an Alpha or a Beta snapshot. Also, they will need to know whether it is a portable or installed version of NVDA.


Other information

They may need other information such as if it was

Example: Running in a VM (virtual machine).

 

Windows version:

Example: Windows 10 Version 1607 Build 14393.1066

 

Other questions:

Does the issue still occur after restarting your PC?

Have you tried any other versions of NVDA?

Please list them and the result

Browse…

No files selected.

Attach files by dragging & dropping, selecting them, or pasting from the clipboard.

Under this section would be where you would post your NVDA log.

Make sure under the general settings in NVDA it is set to Logging level: debug.

If you are lucky someone on the list might do the ticket for you, but you will need to copy and paste the log into the email as attachments are blocked on the list.

After you have filled in the information that they require, locate the submit new issue button and your ticket will be created.

Steps needed to recreate the problem

Please note:
For NVACCESS to try and track down any bugs to be fixed, you need to have the steps to recreate the problem that you are having. Make sure your Logging level is set to debug under the General settings in NVDA. You can also obtain the log which it produces from the Tool…View log section in NVDA. A log will be produced after you press the Enter key on the view log menu. Press the Alt key until a menu drops down, then arrow down until you hear NVDA say “save log as…”, then press the ENTER key. NVDA will default to the filename, then it is a matter of tabbing until you hear a location to save the file to (such as the desktop) then Shift/Tab back to the save button, then press the Enter key on the save button.

Accessing your NVDA log

A much quicker way to get to your NVDA log is by pressing the NVDA key + F1 key, Ctrl then + letter A to select all characters, Ctrl + C to copy, & then pasting Ctrl key + letter V  into an email to send. Or it's in c:\users\username\AppData\local\temp\nvda.log (which you can just attach).

If you have to restart NVDA, then it's in c:\users\username\appdata\local\temp\nvda-old.log.

Miscellaneous information

If you are going to ask somebody else to submit a ticket on your behalf, you cannot add attachments to an email on the NVDA list. The contents of the log can be pasted in the email. If the NVDA log is emailed to another person off list, then the log can be added as an attachment to the ticket.

For more information on using GitHub with a screen reader (which goes beyond making a ticket) please go to the following link http://bats.fyi/2016/08/19/mastering-github-with-a-screen-reader-part-1/

HOME