Create wiki page "How to manage spell check warnings"

[roslynwythe]

Overview

We require a wiki page to guide developers how to manage and resolve spell check warnings

Action Items

• We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Read How to Contribute to the Wiki
• Create a wiki page "How to manage spell check warnings" that covers the following topics:
  • Introduction to spell checking
  • Managing misspelled words
  • Managing false positives
  • Excluding a section of code from spell checking
  • Excluding a file or folder from spell checking

Resources/Instructions

• This issue resulted from Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #4349

Resources/Instructions

Introduction to JSON
Code Spell Checker

---

[roslynwythe]

Draft wiki page "How to manage spell check warnings"

Hack for LA developers are instructed to use Spell Checker for VS Code or the cspell npm package as described in CONTRIBUTING.md Section 1.7. Both versions are intended for working with code files and both utilitze the configuration file cspell.json in the root of the website folder. In the future, cspell-based spell checking will also be incorporated into the GitHub checks which take place in pull requests.

Developers should note spell check warnings (i.e, "unknown word") and resolve them as described below, prior to creating a pull request. File changes made to resolve spell check warnings will be considered within the scope of the linked issue, but should be noted in the Pull Request.

Resolving spell check warnings

- [ ] If there was a genuine misspelling, make the spelling correction(s) 
- [ ] If the "unknown word" should be considerd a "word" (ie "markdownify"), edit the file `cspell.json` and add the term to the "words" array
- [ ] If the "unknown word" should be ignored by the spell checker (such as the name of an individual) edit the file 'cspell.json` and add the term to the "ignoreWords" array
- [ ] It is possible to disable / enable the spell checker for a section of code by adding comments.   Details depend on the file type and can be found in [Code Spell Checker documentation](https://streetsidesoftware.com/vscode-spell-checker/)
- [ ] If the entire file should be excluded from spell checking, because it contains no public-facing text, edit the file `cspell.json` and add the file path to the `ignorePaths` array

[roslynwythe]

@ExperimentsInHonesty In the wiki page I would have liked to reference the issue template for resolving spell check errors, but that link doesn't exist yet so I omitted it.

• How to Contribute to the Wiki has been updated with a link to the draft wiki page so if the draft looks good please close this issue then release the dependency on Create issue template "Resolve Spell Check warning" #6446 - which will be ready for prioritization