Run VS Code Spell Checker on .github/ISSUE_TEMPLATE/img-tag-refactor.md

[roslynwythe]

Overview

We need to audit HfLA codebase files for spelling errors using the Code Spell Checker extension in VS Code in order to ensure site quality. Results will be categorized as misspellings or false positives in the HfLA spelling audit spreadsheet¹ and will be resolved in later issues.

Action Items

• You must use VS Code as your local text editor and install the Code Spell Checker VS Code extension²
• Do not change any configuration settings or make any spell corrections
• Open the file '.github/ISSUE_TEMPLATE/img-tag-refactor.md' and note any Code Spell Checker errors
• Locate the file in column A ("File") of the "Page Audit" sheet. In the column labeled "Result Summary", select the appropriate option: No errors or At least one error.
• If at least one error was reported, copy/paste each cSpell message into a separate row in the Results sheet
• In each new row, select the appropriate value: misspelling or false positive from the "Result type" column. A false positive is a term that is not a misspelling but is not recognized by the spell checker because it is a technical term, abbreviation, acronym, URL or proper noun (name of a person, place or organization).
• Move this issue to the Questions/In Review column and apply the label ready for dev lead

Merge Team

• After this issue is closed, release the dependency on this issue in Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248
• After the last dependency has been released, close that issue

Resources/Instructions

• This issue is part of Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248

Footnotes

1. HfLA spelling audit spreadsheet - Results ↩

2. The recommended installation method is to install Code Spell Checker directly from the VS Code text editor, and those instructions can be found here. The extension can also be installed via the VS Code Marketplace website here. ↩

[github-actions]

Hi @aswutmaxcy, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[aswutmaxcy]

Hello,

I'll be available 8-4 EST M-F and should be done with this EoD 3/21/24.
Will update if ETA needs to be updated.

[aswutmaxcy]

I couldn't get the code spell checker to work on some files, it seemed to only work on certain directories, others it seemed to ignore. I'm not 100% on which ones it's ignoring or not.

I'm using the extension on VScode on win11, I tried using it on remote WSL connection as well with the same results.

How do I get code spell checker to run on the file above? ('.github/ISSUE_TEMPLATE/img-tag-refactor.md)

[aswutmaxcy]

an update to my previous comment:

I removed ln 20 ".github" in the file cspell.json temporarily to let Code Spell Checker spell check the file img-tag-refactor-on-website.md

After which I found no errors and added the line back, updated my local repo, didn't push or commit, and updated the audit excel sheet.

[roslynwythe]

Thank you @aswutmaxcy, you are absolutely correct and it would not be possible to spell check that markdown template without the process you describe. I do apologize for the confusion and I will clarify that in any future issues that audit spelling on templates within the .github folder. Thank you for noting your results in the spreadsheet.