website Epic: Create issues to add false positives to cspell.json

Dependencies

[x] #5313
[ ] #5248 ready for implementation

Overview

We need to create issues to update the Code Spell Checker configuration file with false positives so that they are no longer marked as errors. The list of false positives can be found in the HfLA spelling audit spreadsheet[^1] and that sheet will be used for tracking issues as well.

Action Items

[x] Create template for issues to add false positives to cspell.json - see https://github.com/hackforla/website/issues/5312#issuecomment-1736440177
[x] labels: good first issue, Feature: Infrastructure, role: front end, role: back end/devOps
[x] create sample issue #5618
[ ] Decide how to handle the names of individuals.
[ ] Create issues to add false positives to cspell.json

Resources/Instructions

This issue is part of #5248 [^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.

Aug 26 '23 02:08 roslynwythe

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:

Aug 26 '23 02:08 github-actions[bot]

@wanyuguan I see that you moved this item to Onboarding Info/links and I'm not sure why. Since #5248 is ready for implementation, I would like to work on the template, so I'm releasing the dependency and moving it to In Progress.

Sep 26 '23 23:09 roslynwythe

Template for issues that add false positives to the spell checker config file: NOTE: for handling individuals' names, replace "words" in the template with "ignoreWords"

see also: sample issue #5618

Copy template

### Overview
We need to update the Code Spell Checker configuration file with false positive terms so that they are no longer marked as errors. 

### 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[^1].  The extension can also be installed via the VS Code Marketplace website[^2]
- [ ] Do not change any configuration settings or make any spell corrections
- [ ] Open the file `cspell.json`
- [ ] Replace the line
```
  "words": [
```
with
```
  "words": [
      "[INSERT TERM]",
```
- [ ] Save `cspell.json` and then test the change by opening `[INSERT FILE PATH]` and confirming that no Code Spell Checker errors/messages are displayed.  
- [ ] No docker testing is required.  Create a Pull Request in the usual manner, with changes only to `cspell.json`.   

### Resources
[^1]: [Installing Code Spell Checker from the VS Code text editor](https://code.visualstudio.com/learn/get-started/extensions)
[^2]:[Code Spell Checker - VS Marketplace](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
- This issue was created as part of #5312

View template

Overview

We need to update the Code Spell Checker configuration file with false positive terms so that they are no longer marked as errors.

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[^1]. The extension can also be installed via the VS Code Marketplace website[^2]
[ ] Do not change any configuration settings or make any spell corrections
[ ] Open the file cspell.json
[ ] Replace the line

  "words": [

with

  "words": [
      "[INSERT TERM]",

[ ] Save cspell.json and then test the change by opening [INSERT FILE PATH] and confirming that no Code Spell Checker errors/messages are displayed.
[ ] No docker testing is required. Create a Pull Request in the usual manner, with changes only to cspell.json.

Resources

[^1]: Installing Code Spell Checker from the VS Code text editor [^2]:Code Spell Checker - VS Marketplace

This issue was created as part of #5312

Sep 26 '23 23:09 roslynwythe

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

Sep 26 '23 23:09 github-actions[bot]

@ExperimentsInHonesty Please advise, how should we handle the names of individuals that are flagged as "unknown words" by the spell checker? Currently in our spelling spreadsheet, they are categorized as "false positive" but it is not appropriate to handle them in the same manner as other false positives (such as "hackforla". Options: - edit the html, surrounding names with "comments" that disable code spell checker - add each name to the ignore array in the spell checker configuration file - do nothing and just ignore spell check messages on individuals' names. Are we planning to implement repo-level spell checking that would cause GitHub checks to fail?

Also please review the template above or alternatively this sample issue #5618

Sep 28 '23 05:09 roslynwythe

@roslynwythe

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, October 10, 2023 at 12:06 AM PST.}

Oct 13 '23 07:10 github-actions[bot]

@roslynwythe