Skip to content

Commit

Permalink
Updates to GitHub Issue and PR templates. (nvaccess#12802)
Browse files Browse the repository at this point in the history
Issues:

Rarely, some people answer to the add-on's question thinking to the browser's add-ons rather than NVDA's add-ons (e.g. input[type=number] not announcing value changes when incrementing value with spinbutton nvaccess#12793 (comment))
Localization aspects may be ignored by some people, especially from English speaking countries
Too much checkboxes to check when opening a PR. 

Co-authored-by: Sean Budd <[email protected]>
Co-authored-by: Reef Turner <[email protected]>
  • Loading branch information
3 people authored Sep 17, 2021
1 parent 7935d65 commit 44399c1
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 51 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ Each of the questions and sections below start with multiple hash symbols (#). P

#### Have you tried any other versions of NVDA? If so, please report their behaviors.

#### If add-ons are disabled, is your problem still occurring?
#### If NVDA add-ons are disabled, is your problem still occurring?

#### Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu?
21 changes: 13 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,21 @@ A detailed explanation of this checklist is available here:
https://github.com/nvaccess/nvda/blob/master/devDocs/githubPullRequestTemplateExplanationAndExamples.md#code-review-checklist
-->

- [ ] Pull Request description is up to date.
- [ ] Unit tests.
- [ ] System (end to end) tests.
- [ ] Manual testing.
- [ ] API is compatible with existing addons.
- [ ] User Documentation.
- [ ] Change log entry.
- [ ] Context sensitive help for GUI changes.
- [ ] 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
12 changes: 6 additions & 6 deletions devDocs/githubIssueTemplateExplanationAndExamples.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Please feel free to add more information here to tell us about what you have tri

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

#### Have you tried any other versions of NVDA?
#### Have you tried any other versions of NVDA? If so, please report their behaviors.

Knowing whether this issue occurs in previous releases helps us to understand if this is a newly
introduced issue.
Expand All @@ -178,14 +178,14 @@ It can help us determine if changes in NVDA or other software introduced the pro
> * NVDA 2018.1 - no error sound
> * NVDA 2018.2 - has error sound
#### If addons are disabled, is your problem still occurring?
#### If NVDA add-ons are disabled, is your problem still occurring?

In many cases issues could be caused by an addon not working correctly or conflicting with other
In many cases issues could be caused by an add-on not working correctly or conflicting with other
features already integrated in NVDA itself.
Therefore, it is recommended to reproduce issues with all addons disabled.
In case the issue is caused by an addon, it is recommended to contact the author of the addon first.
Therefore, it is recommended to reproduce issues with all add-ons disabled.
In case the issue is caused by an add-on, it is recommended to contact the author of the add-on first.

#### Did you try to run the COM registry fixing tool in NVDA menu / tools?
#### Does the issue still occur after you run the COM Registration Fixing Tool in NVDA's tools menu?

COM DLL files, which i.e. the IAccessible COM interface depends on, can get unregistered after
installing and uninstalling different programs on a computer.
Expand Down
72 changes: 36 additions & 36 deletions devDocs/githubPullRequestTemplateExplanationAndExamples.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Example:
Are there any known issues or downsides of this approach.
For instance: _Will not work with python 3_

### Change log entry:
### Change log entries:
An entry intended to explain changes in NVDA to end users.
Your proposed entry will be added to the `changes.t2t` file which is converted to html and used as a
what's changed / change log document.
Expand Down Expand Up @@ -124,44 +124,43 @@ Most items in the checklist have a section in the PR template where you can add
so may preempt questions from the reviewer ensuring you are on the same page, and speed up the
review process.

### Pull Request description is up to date.
Authors must keep the PR description up to date.
- Even if changes to the approach are described in the comments for the PR.
- Future developers need a concise explanation of a change.
After each modification, check that the PR description is still accurate.

### Unit tests
- Discuss under "testing strategy" heading.
- Describe the coverage of automated unit tests?
- Is the changed code already, or can it be covered by automated unit tests?

### System tests
- Discuss under "testing strategy" heading.
- Describe the coverage of automated system tests?
- Is the changed code already, or can it be covered by automated unit tests?

### Manual tests
- Discuss under "testing strategy" heading.
- How did you manually test the change?
- Be clear on steps another user can take to replicate your testing.
- Is the described manual testing appropriate for the change?
- Clearly describing this helps alpha testers, and future developers.
- As a reviewer, please use this description to replicate the testing (if possible).

### API is compatible with existing addons.
- If this is not a `.1` breaking release, ensure that all API changes are backwards compatible with existing addons.
### Pull Request description:
- description is up to date.
Authors must keep the PR description up to date.
- Even if changes to the approach are described in the comments for the PR.
- Future developers need a concise explanation of a change.
After each modification, check that the PR description is still accurate.
- change log entries
Has an appropriate change log entry been supplied?
As a reviewer, please review it.

### Testing:
Discuss under "testing strategy" heading:
- Unit tests
- Describe the coverage of automated unit tests?
- Is the changed code already, or can it be covered by automated unit tests?
- System tests
- Describe the coverage of automated system tests?
- Is the changed code already, or can it be covered by automated system tests?
- Manual tests
- How did you manually test the change?
- Be clear on steps another user can take to replicate your testing.
- Is the described manual testing appropriate for the change?
- Clearly describing this helps alpha testers, and future developers.
- As a reviewer, please use this description to replicate the testing (if possible).

### API is compatible with existing add-ons.
- If this is not a `.1` breaking release, ensure that all API changes are backwards compatible with existing add-ons.
- Ensure proposed API changes are included in the change log (Changes for Developers).
- See [Deprecations](./deprecations.md) for more information.

### User Documentation
- Does the user documentation need updating?

### Change log entry
Has an appropriate change log entry been supplied.
As a reviewer, please review it.

### Context sensitive help for GUI changes.
- New GUI options require context sensitive help assignment.
### Documentation
- User Documentation
Does the user documentation need updating?
- Context sensitive help for GUI changes.
New GUI options require context sensitive help assignment.
- Developer / Technical Documentation
Does the developer or technical documentation need updating?

### UX of all users considered
- Users of NVDA are diverse, and rely on different parts of NVDA.
Expand All @@ -170,5 +169,6 @@ As a reviewer, please review it.
- Braille
- Low Vision
- Different web browsers (Firefox, Chrome, Edge)
- Localization in other languages / culture than English
- When one of these can not be supported with this change,
highlight it under the "Known issues" heading

0 comments on commit 44399c1

Please sign in to comment.