Update readme with clearer issue reporting guidelines#19964
Merged
Conversation
Clarify instructions on reporting security issues and translations.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates NVDA’s issue-reporting documentation to better route security- and translation-related reports to the correct channels, reducing confusion for contributors and triagers.
Changes:
- Clarifies that security vulnerabilities should not be filed as GitHub issues and should instead follow the security policy.
- Expands and specifies what “translation-related” issues should be sent to the NVDA Translators list.
- Adds the same translators guidance to the issue template explanation page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| projectDocs/issues/readme.md | Clarifies security reporting channel and expands translation-related reporting guidance. |
| projectDocs/issues/githubIssueTemplateExplanationAndExamples.md | Adds translators guidance to the issue template explanation documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
seanbudd
commented
Apr 17, 2026
XLTechie
suggested changes
Apr 17, 2026
XLTechie
left a comment
XLTechie
left a comment
Collaborator
There was a problem hiding this comment.
The new list of translation issues is nice! A few suggestions, mostly on older text.
Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>
XLTechie
approved these changes
Apr 17, 2026
Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>
Chealer
suggested changes
Apr 17, 2026
SaschaCowley
left a comment
SaschaCowley
left a comment
Member
There was a problem hiding this comment.
Perhaps instead of "that is incorrectly translated from English", we could say "that is incorrect in a language other than English"?
seanbudd
added
the
conceptApproved
Co-authored-by: Sascha Cowley <16543535+SaschaCowley@users.noreply.github.com>
SaschaCowley
requested changes
Apr 21, 2026
Co-authored-by: Sascha Cowley <16543535+SaschaCowley@users.noreply.github.com>
Member
Author
|
pre-commit.ci run |
SaschaCowley
approved these changes
Apr 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify instructions on reporting security issues and translations.
Link to issue number:
Closes #19949
Summary of the issue:
The issues readme says security issues shouldn't be reported via github, but we accept github advisories. We should specify not to use GitHub issues.
It is unclear what materials should be reported to the translators mailing list.
Description of user facing changes:
This pull request updates the issue reporting guidelines in the
projectDocs/issues/readme.mdfile to clarify where to report translation-related issues and to provide more detailed instructions for contributors.Documentation updates: