Create issue template for reporting spell check warning

[roslynwythe]

Overview

We need to create an issue template for reporting spell check "unknown word" warnings, for use when a spell check warning appears in a pull request and the warning cannot be resolved within the pull request process

Action Item

• Create a new template "Resolve Spell Check Warning" - see this comment for the body: Create issue template for reporting spell check warning #5655 (comment)
• labels: "Complexity: Small", "role: front end", "role: back end/devOps", "feature: spelling", "size: 0.5pt", "ready for dev lead"
• Refer to these instructions for testing the issue template and preparing the Pull Request.

Resources/Instructions

Manually creating a single issue template for your repository

• This issue is part of Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #4349

[roslynwythe]

Issue Title: Resolve warning spell check warnings "unknown word": [INSERT WORDS] in [FILE]

Overview

We need to resolve spell checker warning by correcting the misspelling(s), excluding the term(s) from spell checking, or excluding the section of code or the entire file from spell checking.

Action Items

• You must use VS Code as your local text editor to install the VS Code extension for spell checking your codebase, The recommended installation method is to install Code Spell Checker directly from the VS Code text editor¹. The extension can also be installed via the VS Code Marketplace website²
• If the "unknown word" is misspelled, correct the spelling
• If the "unknown word" should be treated as a word (for example, "markdownify" or "hackforla"), add it to the "words" array in the file cspell.json
• If the "unknown word" should be completely ignored by the spell checker (for example, the name of an individual), add it to the "ignoreWords" array in the file cspell.json
• If a file should be excluded from spell checking, add it to the "ignorePaths" array in the file cspell.json
• If the section of a file should be excluded from spell checking, enclose it in these comments

/* cSpell:disable */

and

/* cSpell:enable */

Resources

Footnotes

1. Installing Code Spell Checker from the VS Code text editor ↩

2. Code Spell Checker - VS Marketplace ↩

[github-actions]

Hi @roslynwythe.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:
Complexity, Role, Feature

NOTE: Please ignore the adding proper labels comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards.
To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

• Wiki: How to create issues
• Wiki: How to read and interpret labels

[roslynwythe]

At the 10/3 Dev Lead meeting it was suggested that this issue template is not required because every developer should have responsibility for resolving spell check warnings, either by correcting a misspelling or by resolving false positives by editing cspell.json.

[roslynwythe]

• duplicate of Create issue template "Resolve Spell Check warning" #6446