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 #15182

Closed
wants to merge 0 commits into from
Closed

Use GitHub forms for issues #15182

wants to merge 0 commits into from

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Jul 24, 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-test/issues/new/choose

Example issues filled out using the form are as follows:

Known issues with pull request:

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 seanbudd requested a review from a team as a code owner July 24, 2023 05:15
@seanbudd seanbudd requested a review from michaelDCurran July 24, 2023 05:15
Copy link
Collaborator

@LeonarddeR LeonarddeR left a comment

Choose a reason for hiding this comment

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

Finally. What a lovely improvement this is! I assume the pull requests will follow later on?

.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yml Outdated Show resolved Hide resolved
Please feel free to add more information here to tell us about what you have tried.

- type: input
id: restart
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could this become a checkbox?

Copy link
Member Author

Choose a reason for hiding this comment

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

It seems that the checkbox UX is more designed for what we do with pull requests, a list of checkboxes to confirm with.
I think using input allows people to add additional notes if relevant as well.

description: |
Restarting your computer will help to ensure that software is in a fresh state.

- type: input
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could this be a checkbox?

You can restart NVDA with add-ons disabled through the exit dialog.
In case the issue is caused by an add-on, it is recommended to contact the author of the add-on first.

- type: input
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could this be a checkbox?

.github/ISSUE_TEMPLATE/feature_request.yml Outdated Show resolved Hide resolved
@seanbudd
Copy link
Member Author

I assume the pull requests will follow later on?

GitHub is yet to support forms for pull requests: https://github.com/orgs/community/discussions/31664

@Brian1Gaff

This comment was marked as off-topic.

@amirmahdifard
Copy link

i really like this new form

@seanbudd
Copy link
Member Author

Due to accessibility issues with the form, this is blocked by https://github.com/orgs/community/discussions/61696

@seanbudd
Copy link
Member Author

A GitHub bug has caused this to be closed an unable to be re-opened. #15320 has been opened instead

@seanbudd seanbudd mentioned this pull request Aug 22, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants