Before Reporting
Search existing issues
Check if your issue has already been reported on GitHub Issues
Consider discussing first
If you’re unsure whether something is a bug, open a GitHub Discussion instead
Where to Report
Report on GitHub
Issues are tracked on GitHub using structured templates
Special Cases
Translation Issues
Report translation problems to the NVDA Translators list
Application/Website Issues
Consider reporting to the application/website authors first
Issue Templates
NVDA uses several GitHub issue templates to ensure all necessary information is provided:Bug Reports
Bug Report Template
Report problems with NVDA’s functionality
- Clear steps to reproduce the issue
- Expected behavior vs. actual behavior
- NVDA version and configuration
- Operating system details
- Log file (if applicable)
- Any relevant files or examples
Feature Requests
Feature Request Template
Propose new features or enhancements
- The problem or need the feature addresses
- How it would benefit users
- Potential implementation approaches
- Alignment with NVDA’s product vision
Other Templates
Special Case Issues
Special Case Issues
Use the special case template for issues that don’t fit the bug or feature categories.
Developer Facing Changes
Developer Facing Changes
The developer template is for documenting code improvements, API changes, refactoring, and maintenance tasks.
Add-on Integration Requests
Add-on Integration Requests
Use the add-on integration template to propose integrating functionality from existing community add-ons into NVDA core.
Writing Effective Issue Reports
Essential Information
Steps to Reproduce
Provide clear, numbered steps that anyone can follow to reproduce the issue
Environment Details
Include NVDA version, Windows version, and relevant application versions
Expected vs Actual
Clearly describe what should happen vs. what actually happens
Logs and Files
Attach NVDA log files and any files needed to reproduce the issue
Tips for Quality Reports
Include log files
Include log files
NVDA log files are incredibly helpful for debugging. Learn how to generate and attach log files.If you’re getting a crash dump file (
nvda_crash.dmp), include that as well.Attach necessary files
Attach necessary files
If the issue involves a specific file (Office document, PDF, HTML page), attach it to the issue or provide a link.GitHub has restrictions on file types, but you can always zip files and attach the archive.
Use descriptive titles
Use descriptive titles
Write a clear, specific title that summarizes the issue:
- Good: “NVDA fails to read table headers in Excel 2021 with UIA enabled”
- Poor: “Excel doesn’t work”
Describe images
Describe images
While screenshots can be helpful, many NVDA developers are blind. Always describe what the image shows in text.
Getting Help
If you’re having trouble with the issue template or initial investigation:Ask for Help
The NVDA Users mailing list is a great place to get assistance
For Developers Reporting Issues
If you’re reporting an issue with your application or website:Include a minimal reproducible sample
Provide the smallest possible code or document that demonstrates the issue
Reference specifications
Include details about which accessibility specifications aren’t being handled correctly
Issue Template Guide
Detailed Template Guide
Read the comprehensive guide with examples for filling out GitHub issue templates
Important Notes
Before filling out a template:
- Read through it completely in Browse mode
- Familiarize yourself with GitHub markdown
- Use the preview tab to check formatting
After Reporting
Once you’ve submitted an issue:- Be responsive: Answer questions and provide additional information if requested
- Be patient: Contributors are volunteers and may take time to respond
- Stay subscribed: GitHub will notify you of updates
- Respect priorities: Issues are prioritized based on severity and impact
Advanced: Issue Triage
For those interested in helping with issue management:Issue Triage Guide
Learn how to help triage and investigate issues