diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5299a4c06d6..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - - - -### Steps to reproduce: - -### Actual behavior: - - -### Expected behavior: - - -### NVDA logs, crash dumps and other attachments: - -### System configuration -#### NVDA installed/portable/running from source: - -#### NVDA version: - -#### Windows version: - -#### Name and version of other software in use when reproducing the issue: - -#### Other information about your system: - -### Other questions -#### Does the issue still occur after restarting your computer? - -#### Have you tried any other versions of NVDA? If so, please report their behaviors. - -#### If NVDA add-ons are disabled, is your problem still occurring? - -#### Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu? diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000000..360378faf52 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,200 @@ +name: Bug report +description: Create a bug report to help us improve +labels: [bug] + +body: + - type: markdown + attributes: + value: | + ### Attention! + Please read [our guide](https://github.com/nvaccess/nvda/blob/master/devDocs/githubIssueTemplateExplanationAndExamples.md) on how to fill in this template, including how to provide the required files. + Issues may be closed if the required information is not present. + 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). + 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. + This includes creating or commenting on issues and pull requests. + + - type: textarea + id: summary + attributes: + label: Brief summary + + - type: textarea + id: reproSteps + attributes: + label: Steps to reproduce + description: | + This section should contain a clear and concise list of the steps you take to demonstrate the problem. + 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). + It's important to include any files that are required to reproduce an issue. + This might be an example file, or a link to a minimal code example using CodePen or JSFiddle. + + *Example:* + >1. Open Chrome + >1. Browse to www.google.com + >1. Type "Hello" + >1. Press Enter + validations: + required: true + + - type: textarea + id: actualBehavior + attributes: + label: Actual behavior + description: | + This section should tell us what actually happens when these steps are taken. + Please describe verbatim what NVDA does, use speech and braille viewer to copy the speech/braille from NVDA. + This helps developers to be sure they are reproducing the same issue as you. + Enabling "Speak command keys" (`NVDA+4`) may be helpful. + + *Example:* + >An NVDA error sound is heard. + + >NVDA Speech: + >"button enable sound" + validations: + required: true + + - type: textarea + id: expectedBehavior + attributes: + label: Expected behavior + description: | + This section should tell us what you expect to happen when these steps are taken. + + *Example:* + >There should be no error sound, and the page should change to show the search results. + + >NVDA Speech: + >"checkbox enable sound" + validations: + required: true + + - type: textarea + id: attachedFiles + attributes: + label: NVDA logs, crash dumps and other attachments + description: | + In most cases an NVDA log file is incredibly helpful when trying to understand/fix an issue. + More [instructions are available on the wiki](https://github.com/nvaccess/nvda/wiki/LogFilesAndCrashDumps). + If a crash dump file (nvda_crash.dmp) is created, please also include it. + + - type: markdown + attributes: + value: | + ### System Configuration + The following questions are about the system you are using when encountering the issue. + If you are encountering the issue with multiple different configurations, please list them. + 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. + + - type: dropdown + id: nvdaType + attributes: + label: NVDA type + description: Is this reproduced with NVDA installed/portable/running from source? + multiple: true + options: ["installed copy", "portable copy", installer/launcher copy", "source copy"] + validations: + required: true + + - type: input + id: nvdaVersion + attributes: + label: NVDA version + description: | + Which version(s) of NVDA can you reproduce this issue with? + This can be copied from the about dialog, from the NVDA help menu. + validations: + required: true + + - type: textarea + id: otherNvdaVersions + attributes: + label: Have you tried any other versions of NVDA? If so, please report their behaviors. + description: | + Knowing whether this issue occurs in previous releases helps us to understand if this is a newly introduced issue. + It can help us determine if changes in NVDA or other software introduced the problem. + + *Example:* + > * NVDA 2018.1 - no error sound + > * NVDA 2018.2 - has error sound + + - type: input + id: winVersion + attributes: + label: Windows version + description: | + The version of Windows that you are using. + You can copy this from the "System Information" application: + 1. Press `Windows+r` to open the run dialog + 1. Type `msinfo32` and press enter + 1. From the "System summary" tree-view item, press tab to get to the right pane. + 1. Press down arrow twice to get to "Version" + 1. Press `Control+C` to copy the version information. + + *Example:* + > Windows 10 Version 1607 Build 14393.1066 + validations: + required: true + + - type: textarea + id: otherVersions + attributes: + label: Name and version of other software in use when reproducing the issue + description: | + Typically, you can get this information from the "About" dialog of the software. + + *Example:* + > Chrome version: 67.0.3396.87 + + - type: textarea + id: otherSysInfo + attributes: + label: Other information about your system + description: | + This is other information about your setup that you think might be relevant to us. + + *Example:* + > Running Windows 10 in a VM + + - type: markdown + attributes: + value: | + ### Troubleshooting steps + The following questions ask about the basic investigation steps you may have completed. + Please feel free to add more information here to tell us about what you have tried. + + - type: input + id: restart + validations: + required: true + attributes: + label: Does the issue still occur after restarting your computer? + description: | + Restarting your computer will help to ensure that software is in a fresh state. + + - type: input + id: addons + validations: + required: true + attributes: + label: If NVDA add-ons are disabled, is your problem still occurring? + description: | + In many cases issues could be caused by an add-on not working correctly or conflicting with other features already integrated in NVDA itself. + Therefore, it is recommended to reproduce issues with all add-ons disabled. + You can restart NVDA with add-ons disabled through the exit dialog. + In case the issue is caused by an add-on, it is recommended to contact the author of the add-on first. + + - type: input + id: comRegFix + validations: + required: true + attributes: + label: Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu? + description: | + COM DLL files, which i.e. the IAccessible COM interface depends on, can get unregistered after installing and uninstalling different programs on a computer. + The consequence is that NVDA in certain cases does not work properly. + 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. + The COM registry fixing tool has been introduced in order to re-register those DLL files. + In any case, re-registering those DLL files does not have any negative impact on a computers' functionality. + 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. diff --git a/.github/ISSUE_TEMPLATE/custom_issue.yml b/.github/ISSUE_TEMPLATE/custom_issue.yml new file mode 100644 index 00000000000..0d173eb1485 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom_issue.yml @@ -0,0 +1,20 @@ +name: Custom issue +description: Is your issue not covered by our bug report or feature request template? + +body: + - type: markdown + attributes: + value: | + It is expected that almost every issue on this project is either a feature request or bug report. + Please only select this format in exceptional circumstances, otherwise it will be closed. + Alternatively, consider a [GitHub discussion](https://github.com/nvaccess/nvda/discussions). + Please read [our guide](https://github.com/nvaccess/nvda/blob/master/devDocs/githubIssueTemplateExplanationAndExamples.md) on how to fill in this template, including how to provide the required files. + Issues may be closed if the required information is not present. + 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). + 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. + This includes creating or commenting on issues and pull requests. + + - type: textarea + id: info + attributes: + label: Issue information diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 5c5c643605e..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - - - -### Is your feature request related to a problem? Please describe. - -### Describe the solution you'd like - -### Describe alternatives you've considered - -### Additional context diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000000..0e73a25f473 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,50 @@ +name: Feature request +description: Suggest an idea for this project +labels: [feature] + +body: + - type: markdown + attributes: + value: | + ### Attention! + Please read [our guide](https://github.com/nvaccess/nvda/blob/master/devDocs/githubIssueTemplateExplanationAndExamples.md) on how to fill in this template, including how to provide the required files. + Issues may be closed if the required information is not present. + 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). + 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. + This includes creating or commenting on issues and pull requests. + + - type: textarea + id: problem + validations: + required: true + attributes: + label: Is your feature request related to a problem? Please describe. + description: This section should provide a clear and concise description of what the problem is. + + - type: textarea + id: solution + validations: + required: true + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. + If you can provide technical details about how to address the problem, please do so. + Feel free to add subheadings with markdown. + + - type: textarea + id: altSolution + attributes: + label: Describe alternatives you've considered + description: | + A clear and concise description of any alternative solutions or features you've considered. + If a workaround or solution currently exists, please include why your proposed solution is preferred. + + - type: textarea + id: context + attributes: + label: Additional context + description: | + Add any other context for the feature request here. + This might list the application name and version number that the feature is expected to work with (e.g. Firefox or Microsoft Word). + Also consider whether you can upload an attachment document to be used to demonstrate the missing feature. diff --git a/devDocs/githubIssueTemplateExplanationAndExamples.md b/devDocs/githubIssueTemplateExplanationAndExamples.md index 16c894775df..bd6257d5537 100644 --- a/devDocs/githubIssueTemplateExplanationAndExamples.md +++ b/devDocs/githubIssueTemplateExplanationAndExamples.md @@ -1,9 +1,8 @@ # Creating new issues on the NVDA project -This page is meant to serve as an explanation for how to fill out our -[Github issue templates](https://github.com/nvaccess/nvda/blob/master/.github/ISSUE_TEMPLATE/). +This page is meant to serve as an explanation for how to fill out our [GitHub issues](https://github.com/nvaccess/addon-datastore/issues/new/choose). -The template uses github markdown, to provide formatting for headings, lists, quotes etc. +The template uses GitHub markdown, to provide formatting for headings, lists, quotes etc. If you are not familiar, please take some time to learn about [Github markdown](https://guides.github.com/features/mastering-markdown/) @@ -16,188 +15,23 @@ We currently have two templates, both are described on this page: ## General information The following information applies to all issues (bug reports, new features, even pull requests). -At the start of the template there is an HTML comment block which points to this wiki page, it can -be left in place and will not appear once the issue is saved. -Feel free to delete it. ### Attachments / Images It's important to include any files that are required to reproduce an issue. -This might be a required file for an office suite, or a link to a code playground such as CodePen or -JSFiddle, or perhaps a standalone HTML file. -Github does not allow all -[file types to be attached](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), -however, zip files are allowed, so you can always zip your file and attach that instead. +This might be a required file for an office suite, or a link to a code playground such as CodePen or JSFiddle, or perhaps a standalone HTML file. +Github does not allow all [file types to be attached](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), however, zip files are allowed, so you can always zip your file and attach that instead. #### Logs -In most cases an NVDA log file is incredibly helpful when trying to understand/fix an issue, please -remember to attach one. -More [instructions are available on the wiki](https://github.com/nvaccess/nvda/wiki/LogFilesAndCrashDumps). If you are getting a crash dump file (nvda_crash.dmp) please also include it. +In most cases an NVDA log file is incredibly helpful when trying to understand/fix an issue, please remember to attach one. +More [instructions are available on the wiki](https://github.com/nvaccess/nvda/wiki/LogFilesAndCrashDumps). +If you are getting a crash dump file (nvda_crash.dmp) please also include it. #### Screenshots -While we welcome **images/screenshots** to help explain a problem, be aware that many of the -developers of NVDA are blind and will greatly appreciate this image being described in text. +While we welcome **images/screenshots** to help explain a problem, be aware that many of the developers of NVDA are blind and will greatly appreciate this image being described in text. Most tools allow you to copy text out of them. ### Tips * Consider swapping to the preview tab in order to read through your issue at any stage to confirm the issue reads as expected. -* If you have trouble following this template, or with the initial investigation that is required, - please politely ask for assistance from the fantastic community of people on the - [NVDA users mailing list](https://github.com/nvaccess/nvda-community/wiki/Connect#international-users-mailing-list-english) - - -## Feature Request template - -After the HTML comment ([discussed earlier](#General_information)), you may provide a brief overview -of the issue. -Then fill in each of the following headings which match those that are found in the template, with a -short description of how to fill in each section. - -### Is your feature request related to a problem? Please describe. -This section should provide a clear and concise description of what the problem is. -Ex. I'm always frustrated when [...] - -### Describe the solution you'd like -A clear and concise description of what you want to happen. -If you can provide technical details about how to address the problem, please do so. -Feel free to add a subheading. - -### Describe alternatives you've considered -A clear and concise description of any alternative solutions or features you've considered. - -### Additional context -Add any other context for the feature request here. -This might list the application name and version number that the feature is expected to work with -(EG Firefox or Microsoft Word). -Also consider whether you can upload an attachment document to be used to demonstrate the missing -feature. - -## Bug report template - -After the HTML comment ([discussed earlier](#general-information)), you may provide a brief overview -of the issue. -Then fill in each of the following headings which match those that are found in the template, with a -short description of how to fill in each section. - -### Steps to reproduce: - -This section is very important, please be clear and concise. -This section should contain a list of the steps you take to demonstrate the problem. -While you are working out the steps required, please make a copy of your -[NVDA log to attach to the issue](https://github.com/nvaccess/nvda/wiki/LogFilesAndCrashDumps). - -*Example:* -> 1. Open Chrome -> 1. Browse to www.google.com -> 1. Type "Hello" -> 1. Press Enter - -### Actual behavior: -This section should tell us what actually happens when these steps are taken. -Please describe verbatim what NVDA does, ideally use speech viewer to copy the speech from NVDA. -This helps developers to be sure they are reproducing the same issue as you. - -*Example:* -> An NVDA error sound is heard. - -> NVDA Speech: -> "button enable sound" - -### Expected behavior: -This section should tell us what you expect to happen when these steps are taken. - -*Example:* -> There should be no error sound, and the page should change to show the search results. - -> NVDA Speech: -> "checkbox enable sound" - -### NVDA logs, crash dumps and other attachments - -Refer to [Attachments / Images](#attachments--images). - -### System configuration: - -This section has several sub-sections. -These are all about the system you are using when encountering the issue. -If you are encountering the issue with multiple different configurations, please list them. -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. - -#### NVDA installed/portable/running from source: -This tells us how you are using NVDA. - -*Example:* -> Installed - -#### NVDA version: -The version of NVDA that you are using when demonstrating the issue. -This can be copied from the about option, in the NVDA help menu. - -*Example:* -> alpha-15370,21fd217a - -> release 2020.4 - -#### Windows version: -The version of Windows that you are using. -You can copy this from the "System Information" application: -1. Press `Windows+r` to open the run dialog -1. Type `msinfo32` and press enter -1. From the "System summary" treeview item, press tab to get to the right pane. -1. Press down arrow twice to get to "Version" -1. Press `Control+C` to copy the version information. - -*Example:* -> Windows 10 Version 1607 Build 14393.1066 - -#### Name and version of other software in use when reproducing the issue: -Typically, you can get this information from the "About" dialog of the software. - -*Example:* -> Chrome version: 67.0.3396.87 - -#### Other information about your system: -This is other information about your setup that you think might be relevant to us. - -*Example:* -> Running Windows 10 in a VM - -### Other questions: -This section has sub-sections, asking about the basic investigation steps you may have completed. -Please feel free to add more information here to tell us about what you have tried. - -#### Does the issue still occur after restarting your Computer? - -Restarting your computer will help to ensure that software is in a fresh state. - -#### Have you tried any other versions of NVDA? If so, please report their behaviors. - -Knowing whether this issue occurs in previous releases helps us to understand if this is a newly -introduced issue. -It can help us determine if changes in NVDA or other software introduced the problem. - -*Example:* -> * NVDA 2018.1 - no error sound -> * NVDA 2018.2 - has error sound - -#### If NVDA add-ons are disabled, is your problem still occurring? - -In many cases issues could be caused by an add-on not working correctly or conflicting with other -features already integrated in NVDA itself. -Therefore, it is recommended to reproduce issues with all add-ons disabled. -In case the issue is caused by an add-on, it is recommended to contact the author of the add-on first. - -#### Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu? - -COM DLL files, which i.e. the IAccessible COM interface depends on, can get unregistered after -installing and uninstalling different programs on a computer. -The consequence is that NVDA in certain cases does not work properly. -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. -The COM registry fixing tool has been introduced in order to re-register those DLL files. -In any case, re-registering those DLL files does not have any negative impact on computers' -functionality. -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. +* If you have trouble following this template, or with the initial investigation that is required, please politely ask for assistance from the fantastic community of people on the [NVDA users mailing list](https://github.com/nvaccess/nvda-community/wiki/Connect#international-users-mailing-list-english)