-
-
Notifications
You must be signed in to change notification settings - Fork 638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use GitHub forms for issues #15320
base: master
Are you sure you want to change the base?
Use GitHub forms for issues #15320
Conversation
Co-authored-by: Leonard de Ruijter <[email protected]>
Co-authored-by: Leonard de Ruijter <[email protected]>
Note: re-opened take of #15182, refer to comments and reviews there as well |
See test results for failed build of commit 672eacd963 |
See test results for failed build of commit f7fb95afcb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current order of issue types seems off to me, so I've suggested renaming the files to change the order of forms to a more intuitive (to me) order.
@@ -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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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). | |
This page is meant to serve as an explanation for how to fill out our [GitHub issues](https://github.com/nvaccess/nvda/issues/new/choose). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest renaming to 1-bug_report.yml
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest renaming to 3-custom_issue.yml
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest renaming to 2-feature_request.yml
.
@seanbudd could we wait for our call next week before merging this? I have some proposals / ideas that we could discuss there. |
@Adriani90 - this PR is still blocked by work from GitHub |
I've tested the forms and yeah, I think the most annoying part is that the labels of the fields are dissociated from the fields when the focus lands on them. I think this is still a showstopper. But also the edit fields seem to be smaller in height, at least that's what I read in some forums. This might be very annoying for people with some vision ability. @seanbudd did you explore the possibility of providing accessible landing pages for the issue templates with the ability of creating githug issues from those pages? Or maybe there is an alternative tool for customizing the github issue interface? I found this one but it seems inactive: |
It seems fields can be filled by passing GET parameters to the URL. It would be nice to add a "Report a bug" and "Request a feature" options in the NVDA menu, where we can prefill things like the Windows version, NVDA version etc. We could also provide a native GUI there for the now partly accessible fields, so people only have to activate the Create issue button on the webpage that opens. |
@bramd How would that work with respect to GitHub authentication?
If the user doesn't have an account, it fails until they create one, at which point they have to fill them again.
If they do, NVDA would have to go through a per-user oauth2 process, I believe, to authenticate the user with NVDA.
If you mean to just pass the information as query string parameters, we return to the first problem, but with the added wrinkle that it needs to open in a browser with an already active session cookie.
For the average user, that is unlikely to be the case.
Or am I missing something in your idea?
|
Link to issue number:
None
Summary of the issue:
GitHub issue forms provide an easier and more clear way for users to report issues on the NVDA project.
Currently, when filling out an issue form, inline comments and an external guide is required to understand how to fill out an issue.
Description of user facing changes
When reporting an issue to NVDA, users can use the simpler GitHub forms interface.
Information from inline comments and the issue guide have been merged into this form, so that it is easier to understand the requirements.
Additionally, a new "custom issue" has been created, as we disable opening blank issues.
This should be used in the rare circumstance when the bug report or feature request template is not appropriate
Description of development approach
N/A
Testing strategy:
These changes have been pushed to a test repository
The new issue interface can be tested here: https://github.com/nvaccess/nvda-issue-form-test/issues/new/choose
Example issues filled out using the form are as follows:
Known issues with pull request:
This PR is blocked by accessibility issues outlined in: https://github.com/orgs/community/discussions/61696.
The current information for the bug report may be overly verbose.
However, it is rare that an issue reporter reads our external guide for reporting issues, and as such, inline information is preferred.
Change log entries:
N/A
Code Review Checklist: