Skip to content

Request more specific information in bug report#13905

Merged
seanbudd merged 4 commits into
masterfrom
expandBugReport
Jul 20, 2022
Merged

Request more specific information in bug report#13905
seanbudd merged 4 commits into
masterfrom
expandBugReport

Conversation

@seanbudd

Copy link
Copy Markdown
Member

Link to issue number:

None

Summary of the issue:

It would be helpful if bug reporters include exact speech/braille that is expected vs. occurring.
This is requested in devDocs\githubIssueTemplateExplanationAndExamples.md but not in the issue template.

It would also be good to add a section for logs and other attachments, as they are often required when reporting an issue.
This is also requested in devDocs\githubIssueTemplateExplanationAndExamples.md but not in the issue template.

Description of user facing changes

Bug reports are now prompted to include explicit speech/braille and NVDA logs.

Description of development approach

N/a

Testing strategy:

Community feedback/usage of new sections

Known issues with pull request:

None

Change log entries:

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

@seanbudd seanbudd requested a review from a team as a code owner July 15, 2022 00:21
@seanbudd seanbudd requested a review from feerrenrut July 15, 2022 00:21
Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated

### Actual behavior:

#### Actual NVDA speech/braille sample:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm not sure that this always applies to bug reports. For instance, no (unexpected) speech/Braille is present when apps crash or hang or for developer-facing changes (an API works in an unexpected way, etc.)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It can be left blank in those cases.
It might be worth indicating optional fields (e.g. including the "other questions", which are generally less relevant than expected speech, NVDA logs, etc)

@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit a3fd1d124a

Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
Comment on lines +18 to +20
### Actual behavior:

#### Actual NVDA speech/braille sample:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What if this is an instruction under the heading instead?

Suggested change
### Actual behavior:
#### Actual NVDA speech/braille sample:
### Actual behavior:
<!--
Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here.
Use braille viewer to copy and paste here.
You may additionally include an explanation.
-->

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would be reluctant to ask users to copy from Braille viewer, as that is not something which can be done using keyboard only.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think these instructions are more likely to be ignored than an explicit field, but this might be a better solution as copied speech/braille is not always relevant (as per #13905 (comment)).

Fixing braille viewer copy/paste sounds like an important thing to do as well.

@seanbudd seanbudd requested a review from feerrenrut July 18, 2022 06:26
@seanbudd seanbudd merged commit 0f9c0da into master Jul 20, 2022
@seanbudd seanbudd deleted the expandBugReport branch July 20, 2022 00:39
@nvaccessAuto nvaccessAuto added this to the 2022.3 milestone Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants