Create initial spell check configuration file

[roslynwythe]

Overview

As developers introducing the use of the VSCode Code Spell Checker extension, we need to provide a folder-level configuration file cspell.json in the website folder, which will establish site spell check settings.

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²
• Create a new file cspell.json in the website (root) folder.
• Copy/paste the following:

{
    "version": "0.2",
    "language": "en",
    // words - list of words to be always considered correct
    "words": [
        "collabathon"   
    ],
    "ignorePaths": [
        "node_modules",
        ".github"
    ]
}

• Save the file then test the VSCode Spell Checker extension:
  • Open a few files in .github/workflows and confirm that no spell check errors appear
  • Open the file _includes/about-page/about-card-sustainability.html
    • Confirm that the term Collabathon is not marked as an error or unknown word
    • Confirm that the term Undebate is marked as an unknown word
• Add/Commit the file cspell.json and proceed with a Pull Request in the usual manner

Resources/Instructions

Footnotes

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

2. Code Spell Checker - VS Marketplace ↩

[roslynwythe]

@ExperimentsInHonesty this is a basic configuration file and will be filled out with additional words, paths, and exclude patterns in subsequent issues.

[github-actions]

Hi @erinzz, 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 :)

[erinzz]

Avail M-F 9-5
ETA: 9/11 EOD

[roslynwythe]

Hi @erinzz please update the ETA on this issue. This issue is time-sensitive and I would like to help in any way that I can so please send me a Slack DM if you run into any problems. Thank you!