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:

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

[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

[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[bot]]

Walkthrough

The recent updates introduce a new template for reporting special case issues and enhance the documentation on GitHub issue templates. This includes revising the warning message, expanding the list of template options, and providing detailed guidance on using the new special case issue template. These changes aim to streamline issue reporting and ensure comprehensive documentation for various issue types.

Changes

Files	Change Summary
.github/ISSUE_TEMPLATE/special_case_issue.md	Introduced a new template for reporting complex or exceptional issues that do not fit standard categories.
projectDocs/issues/githubIssueTemplateExplanationAndExamples.md	Updated warning message, expanded template options, and added a section with detailed instructions for the new special case issue template.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[seanbudd]

Looks good to me, just one optional suggestion