Use GitHub forms for issues

[seanbudd]

Link to issue number:

Blocked by https://github.com/orgs/community/discussions/61696.

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:

• Example bug report nvda-issue-form-test#1
• Example feature request nvda-issue-form-test#2
• Example custom issue nvda-issue-form-test#3

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]

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

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/fl6ul678drpayfw7/artifacts/output/nvda_snapshot_pr15320-28929,672eacd9.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.8,
  INSTALL_END 0.9,
  BUILD_START 0.0,
  BUILD_END 25.3,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 22.4,
  FINISH_END 0.1

See test results for failed build of commit 672eacd963

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/oiy015l27dm3vt37/artifacts/output/nvda_snapshot_pr15320-29047,f7fb95af.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 0.8,
  INSTALL_END 0.8,
  BUILD_START 0.0,
  BUILD_END 23.7,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.3,
  TEST_START 0.0,
  TEST_END 22.1,
  FINISH_END 0.2

See test results for failed build of commit f7fb95afcb

[SaschaCowley]

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.

[SaschaCowley]

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

[SaschaCowley]

Suggest renaming to 1-bug_report.yml.

[SaschaCowley]

Suggest renaming to 3-custom_issue.yml.

[SaschaCowley]

Suggest renaming to 2-feature_request.yml.

[Adriani90]

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

[seanbudd]

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

[Adriani90]

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]

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]

@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?