|
| 1 | +name: Bug report |
| 2 | +description: Create a bug report to help us improve |
| 3 | +type: Bug |
| 4 | +labels: [bug] |
| 5 | + |
| 6 | +body: |
| 7 | + - type: markdown |
| 8 | + attributes: |
| 9 | + value: | |
| 10 | + ### Attention! |
| 11 | +
|
| 12 | + Please read [our guide](https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/githubIssueTemplateExplanationAndExamples.md) on how to fill in this template, including how to provide the required files. |
| 13 | + Issues may be closed if the required information is not present. |
| 14 | +
|
| 15 | + Please also note that the NVDA project has a [Citizen and Contributor Code of Conduct](https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md). |
| 16 | + NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. |
| 17 | + This includes creating or commenting on issues and pull requests. |
| 18 | +
|
| 19 | + - type: textarea |
| 20 | + id: summary |
| 21 | + attributes: |
| 22 | + label: Brief summary |
| 23 | + |
| 24 | + - type: textarea |
| 25 | + id: reproSteps |
| 26 | + attributes: |
| 27 | + label: Steps to reproduce |
| 28 | + description: | |
| 29 | + This section should contain a clear and concise list of the steps you take to demonstrate the problem. |
| 30 | + While performing the steps required, please make a copy of your [NVDA log to attach to the issue](https://github.com/nvaccess/nvda/wiki/LogFilesAndCrashDumps). |
| 31 | + It's important to include any files that are required to reproduce an issue. |
| 32 | + This might be an example file, or a link to a minimal code example using CodePen or JSFiddle. |
| 33 | +
|
| 34 | + placeholder: | |
| 35 | + Example: |
| 36 | +
|
| 37 | + 1. Open Chrome |
| 38 | + 2. Browse to www.google.com |
| 39 | + 3. Type "Hello" |
| 40 | + 4. Press Enter |
| 41 | + validations: |
| 42 | + required: true |
| 43 | + |
| 44 | + - type: textarea |
| 45 | + id: actualBehavior |
| 46 | + attributes: |
| 47 | + label: Actual behavior |
| 48 | + description: | |
| 49 | + This section should tell us what actually happens when these steps are taken. |
| 50 | + Please describe verbatim what NVDA does, use speech and braille viewer to copy the speech/braille from NVDA. |
| 51 | + This helps developers to be sure they are reproducing the same issue as you. |
| 52 | + Enabling "Speak command keys" (`NVDA+4`) may be helpful. |
| 53 | +
|
| 54 | + placeholder: | |
| 55 | + Example: |
| 56 | +
|
| 57 | + An NVDA error sound is heard. |
| 58 | +
|
| 59 | + NVDA Speech: |
| 60 | + "button enable sound" |
| 61 | + validations: |
| 62 | + required: true |
| 63 | + |
| 64 | + - type: textarea |
| 65 | + id: expectedBehavior |
| 66 | + attributes: |
| 67 | + label: Expected behavior |
| 68 | + description: | |
| 69 | + This section should tell us what you expect to happen when these steps are taken. |
| 70 | +
|
| 71 | + placeholder: | |
| 72 | + Example: |
| 73 | +
|
| 74 | + There should be no error sound, and the page should change to show the search results. |
| 75 | +
|
| 76 | + NVDA Speech: |
| 77 | + "checkbox enable sound" |
| 78 | + validations: |
| 79 | + required: true |
| 80 | + |
| 81 | + - type: textarea |
| 82 | + id: attachedFiles |
| 83 | + attributes: |
| 84 | + label: NVDA logs, crash dumps and other attachments |
| 85 | + description: | |
| 86 | + In most cases an NVDA log file is incredibly helpful when trying to understand/fix an issue. |
| 87 | + More [instructions are available on the wiki](https://github.com/nvaccess/nvda/wiki/LogFilesAndCrashDumps). |
| 88 | + If a crash dump file (nvda_crash.dmp) is created, please also include it. |
| 89 | +
|
| 90 | + - type: markdown |
| 91 | + attributes: |
| 92 | + value: | |
| 93 | + ### System Configuration |
| 94 | +
|
| 95 | + The following questions are about the system you are using when encountering the issue. |
| 96 | + If you are encountering the issue with multiple different configurations, please list them. |
| 97 | + This helps us to be able to reproduce the issue, or help us to investigate why this issue occurs for some users and not others. |
| 98 | +
|
| 99 | + - type: dropdown |
| 100 | + id: nvdaType |
| 101 | + attributes: |
| 102 | + label: NVDA type |
| 103 | + description: Is this reproduced with NVDA installed/portable/running from source? |
| 104 | + multiple: true |
| 105 | + options: ["installed copy", "portable copy", "installer/launcher copy", "source copy"] |
| 106 | + validations: |
| 107 | + required: true |
| 108 | + |
| 109 | + - type: input |
| 110 | + id: nvdaVersion |
| 111 | + attributes: |
| 112 | + label: NVDA version |
| 113 | + description: | |
| 114 | + Which version(s) of NVDA can you reproduce this issue with? |
| 115 | + This can be copied from the about dialog, from the NVDA help menu. |
| 116 | + validations: |
| 117 | + required: true |
| 118 | + |
| 119 | + - type: textarea |
| 120 | + id: otherNvdaVersions |
| 121 | + attributes: |
| 122 | + label: Have you tried any other versions of NVDA? If so, please report their behaviors. |
| 123 | + description: | |
| 124 | + Knowing whether this issue occurs in previous releases helps us to understand if this is a newly introduced issue. |
| 125 | + It can help us determine if changes in NVDA or other software introduced the problem. |
| 126 | +
|
| 127 | + placeholder: | |
| 128 | + Example: |
| 129 | +
|
| 130 | + * NVDA 2018.1 - no error sound |
| 131 | + * NVDA 2018.2 - has error sound |
| 132 | +
|
| 133 | + - type: input |
| 134 | + id: winVersion |
| 135 | + attributes: |
| 136 | + label: Windows version |
| 137 | + description: | |
| 138 | + The version of Windows that you are using. |
| 139 | + You can copy this from the "System Information" application: |
| 140 | + 1. Press `Windows+r` to open the run dialog |
| 141 | + 1. Type `msinfo32` and press enter |
| 142 | + 1. From the "System summary" tree-view item, press tab to get to the right pane. |
| 143 | + 1. Press down arrow twice to get to "Version" |
| 144 | + 1. Press `Control+C` to copy the version information. |
| 145 | +
|
| 146 | + placeholder: | |
| 147 | + Example: Windows 10 Version 1607 Build 14393.1066 |
| 148 | +
|
| 149 | + validations: |
| 150 | + required: true |
| 151 | + |
| 152 | + - type: textarea |
| 153 | + id: otherVersions |
| 154 | + attributes: |
| 155 | + label: Name and version of other software in use when reproducing the issue |
| 156 | + description: | |
| 157 | + Typically, you can get this information from the "About" dialog of the software. |
| 158 | +
|
| 159 | + placeholder: | |
| 160 | + Example: |
| 161 | +
|
| 162 | + Chrome version: 67.0.3396.87 |
| 163 | +
|
| 164 | + - type: textarea |
| 165 | + id: otherSysInfo |
| 166 | + attributes: |
| 167 | + label: Other information about your system |
| 168 | + description: | |
| 169 | + This is other information about your setup that you think might be relevant to us. |
| 170 | +
|
| 171 | + placeholder: | |
| 172 | + Example: |
| 173 | +
|
| 174 | + Running Windows 10 in a VM |
| 175 | +
|
| 176 | + - type: markdown |
| 177 | + attributes: |
| 178 | + value: | |
| 179 | + ### Troubleshooting steps |
| 180 | +
|
| 181 | + The following questions ask about the basic investigation steps you may have completed. |
| 182 | + Please feel free to add more information here to tell us about what you have tried. |
| 183 | +
|
| 184 | + - type: dropdown |
| 185 | + id: restart |
| 186 | + validations: |
| 187 | + required: true |
| 188 | + attributes: |
| 189 | + label: Does the issue still occur after restarting your computer? |
| 190 | + description: | |
| 191 | + Restarting your computer will help to ensure that software is in a fresh state. |
| 192 | + options: [ |
| 193 | + "I have restarted my computer and the issue still occurs", |
| 194 | + "Restarting my computer fixes the issue temporarily, but it comes back later", |
| 195 | + "Restarting my computer fixed the issue", |
| 196 | + "I have not restarted my computer", |
| 197 | + ] |
| 198 | + |
| 199 | + - type: dropdown |
| 200 | + id: addons |
| 201 | + validations: |
| 202 | + required: true |
| 203 | + attributes: |
| 204 | + label: If NVDA add-ons are disabled, is your problem still occurring? |
| 205 | + description: | |
| 206 | + In many cases issues could be caused by an add-on not working correctly or conflicting with other features already integrated in NVDA itself. |
| 207 | + Therefore, it is recommended to reproduce issues with all add-ons disabled. |
| 208 | + You can restart NVDA with add-ons disabled through the exit dialog. |
| 209 | + In case the issue is caused by an add-on, it is recommended to contact the author of the add-on first. |
| 210 | + options: [ |
| 211 | + "I have restarted NVDA with add-ons disabled and the issue still occurs", |
| 212 | + "I have restarted NVDA with add-ons disabled and the issue no longer occurs", |
| 213 | + "I have not restarted NVDA with add-ons disabled", |
| 214 | + "I do not have any NVDA add-ons installed", |
| 215 | + ] |
| 216 | + |
| 217 | + - type: dropdown |
| 218 | + id: comRegFix |
| 219 | + validations: |
| 220 | + required: true |
| 221 | + attributes: |
| 222 | + label: Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu? |
| 223 | + description: | |
| 224 | + COM DLL files, which the IAccessible COM interface depends on, can get unregistered after installing and uninstalling different programs on a computer. |
| 225 | + The consequence is that NVDA in certain cases does not work properly. |
| 226 | + Specifically, it reports "unknown" when trying to navigate websites or fails to switch between focus and browse mode, it causes performance issues, focus instability and other odd problems. |
| 227 | + The COM registry fixing tool has been introduced in order to re-register those DLL files. |
| 228 | + In any case, re-registering those DLL files does not have any negative impact on a computer's functionality. |
| 229 | + Note that when installing NVDA, this tool is run automatically. |
| 230 | + Thus, it is recommended to run the fixing tool whenever focus problems, performance problems on websites or navigation problems in focus or browse mode on different interfaces are encountered. |
| 231 | + options: [ |
| 232 | + "I have run the COM Registration Fixing Tool and the issue still occurs", |
| 233 | + "I have run the COM Registration Fixing Tool and the issue no longer occurs", |
| 234 | + "I have not run the COM Registration Fixing Tool", |
| 235 | + ] |
0 commit comments