Create special_case_issue.md issue template

[gerald-hartig]

Link to issue number:

n/a

Summary of the issue:

NV Access has received feedback from the community that the current issue templates are insufficient to cover all the possible community requests and work that is required on NVDA. In an effort to balance the benefits of using templates with the flexibility required to handle unknown-unknowns, we are creating a new template.

Description of user facing changes

New issue type: Special Case Issue

Description of development approach

Creation of template md file. Update to documentation.

Testing strategy:

n/a

Known issues with pull request:

None

Code Review Checklist:

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

Summary by CodeRabbit

• New Features

  • Introduced a new template for reporting special case issues that do not fit standard categories.

• Documentation

  • Updated issue template documentation to include information on the new special case issue template.
  • Revised warning message to reflect the requirement of completing one of the provided templates.
  • Expanded template options to cover feature requests, bug reports, special case issues, and security vulnerabilities.

[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/l7hcx7fq1y9279v2/artifacts/output/nvda_snapshot_pr16452-31678,0192d8de.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.1,
  INSTALL_END 1.0,
  BUILD_START 0.0,
  BUILD_END 27.9,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.4,
  TEST_START 0.0,
  TEST_END 2.4,
  FINISH_END 0.2

See test results for failed build of commit 0192d8dede

[Qchristensen]

Reads well. Will be interesting to see what issues we get on this template.

[mwhapples]

This mostly looks good. One small comment I have is regarding line 14 where it says issues may be closed if all required information is not provided. May be this should be fairer to issue submitters, it probably should say that where required information is not provided when requested the issue may be closed. I feel we should make it seem like submitters will be given a chance to provide information they may have accidentally missed from the initial report, either because of a mistake or because they didn't actually know enough to know what may or may not have been important to developers when making the initial issue.

[coderabbitai]

Actionable comments posted: 23

Out of diff range and nitpick comments (1)

projectDocs/issues/githubIssueTemplateExplanationAndExamples.md (1)

Line range hint 52-53: Remove consecutive blank lines.

- 
- 
+ 

[coderabbitai]

Actionable comments posted: 19

Out of diff range and nitpick comments (1)

projectDocs/issues/githubIssueTemplateExplanationAndExamples.md (1)

Line range hint 52-53: Remove consecutive blank lines.

- 
- 
+ 

[coderabbitai]

Actionable comments posted: 5

Out of diff range and nitpick comments (9)

projectDocs/issues/githubIssueTemplateExplanationAndExamples.md (9)

Line range hint 6-8: Capitalize "Markdown" as it is a proper noun.

- The template uses github markdown, to provide formatting for headings, lists, quotes etc.
+ The template uses GitHub Markdown, to provide formatting for headings, lists, quotes etc.

---

Line range hint 32-32: Separate "however" from the sentence for proper conjunction usage.

- however, zip files are allowed, so you can always zip your file and attach that instead.
+ However, zip files are allowed, so you can always zip your file and attach that instead.

---

Line range hint 46-46: Consider a shorter alternative to avoid wordiness.

- * Consider swapping to the preview tab in order to read through your issue at any stage to confirm the issue reads as expected.
+ * Consider using the preview tab to confirm your issue reads as expected.

---

Line range hint 88-88: Consider replacing "very important" with a less over-used intensifier.

- This section is very important, please be clear and concise.
+ This section is crucial, please be clear and concise.

---

Line range hint 125-125: This word is normally spelled as one.

- This section has several sub-sections.
+ This section has several subsections.

---

Line range hint 139-139: Use "about" as an adjective instead of an adverb.

- This can be copied from the about option, in the NVDA help menu.
+ This can be copied from the "About" option, in the NVDA help menu.

---

Line range hint 171-171: This word is normally spelled as one.

- This section has sub-sections, asking about the basic investigation steps you may have completed.
+ This section has subsections, asking about the basic investigation steps you may have completed.

---

Line range hint 189-189: Insert a comma after "cases" for clarity.

- In many cases issues could be caused by an add-on not working correctly or conflicting with other features already integrated in NVDA itself.
+ In many cases, issues could be caused by an add-on not working correctly or conflicting with other features already integrated in NVDA itself.

---

Line range hint 197-197: Consider putting a comma before the abbreviation "i.e.".

- COM DLL files, which i.e. the IAccessible COM interface depends on, can get unregistered after installing and uninstalling different programs on a computer.
+ COM DLL files, which, i.e., the IAccessible COM interface depends on, can get unregistered after installing and uninstalling different programs on a computer.

[coderabbitai]

Actionable comments posted: 4

[seanbudd]

Looks good to me, just one optional suggestion