ER: need to manage spell check false positives in markdown files

[roslynwythe]

Emergent Requirement - Problem

Some portions of markdown generates numerous false positives from the VS Code Spell Checker extension, and it is desirable to exclude those portions from spell checking. This ER focuses on these instances:

• proper names
• Lorem ipsum placeholder text

Details

For HTML and JavaScript files, it is possible to exclude a portion of the text from spell checking, using specially formatted comments. Examples of such comments can be found here in the cspell documentation. However for markdown files the situation is different because:

• since markdown does not support "comments", it is not clear which if any of those those methods can be used
• the formatting in markdown files lends itself it using exclude/include regex patterns in the cspell configuration; for example we might use regex to exclude lines such as - name: Bonnie Wolfe

Issue you discovered this emergent requirement in

• Run VS Code Spell Checker on how-to-set-reminders-in-slack.md #6753

Date discovered

6/14/2024

Did you have to do something temporarily

• YES
• NO

Who was involved

@roslynwythe

What happens if this is not addressed

We will have large numbers of false positives, which may pose a bigger problem when we implement spell checking in Pull Requests. False positives can be managed individually in the cspell configuration file. Alternatively we could exclude entire files from spell checking.

Resources

https://cspell.org/configuration/patterns/
https://cspell.org/configuration/document-settings/#enable--disable-checking-sections-of-code

Recommended Action Items

• Make a new issue 1 - update spell check config file to ignore members' names #7010
• Make new issue 2 - Investigate method for excluding blocks of text in markdown from spell checking #7011
• Added new issue 3 - Update spell check cspell.json to ignore members' github handles #7099

Potential solutions [draft]

[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 this 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