Skip to content
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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Use GitHub forms for issues #15320

wants to merge 7 commits into from

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Aug 22, 2023

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:

  • Pull Request description:
    • description is up to date
    • change log entries
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

@seanbudd
Copy link
Member Author

Note: re-opened take of #15182, refer to comments and reviews there as well

@AppVeyorBot
Copy link

See test results for failed build of commit 672eacd963

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Aug 29, 2023
@AppVeyorBot
Copy link

See test results for failed build of commit f7fb95afcb

Copy link
Member

@SaschaCowley SaschaCowley left a 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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).

Copy link
Member

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.

Copy link
Member

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.

Copy link
Member

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.

@Adriani90
Copy link
Collaborator

@seanbudd could we wait for our call next week before merging this? I have some proposals / ideas that we could discuss there.

@seanbudd
Copy link
Member Author

@Adriani90 - this PR is still blocked by work from GitHub

@Adriani90
Copy link
Collaborator

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:
https://github.com/wei/new-issue

@bramd
Copy link
Contributor

bramd commented Sep 5, 2024

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.

@XLTechie
Copy link
Collaborator

XLTechie commented Sep 5, 2024 via email

@seanbudd seanbudd added the blocked/merge-conflicts Merge conflicts exist on this PR label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked/merge-conflicts Merge conflicts exist on this PR blocked/needs-external-fix blocked conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants