update spell check config file to ignore members' names
Overview
We need to update the code spell check configuration file so that the spell checker excludes lines matching - name: from checking, in order to reduce the number of false positives ("unknown word").
Action Items
- [x] Open the configuration file
cspell.jsonin your IDE - [x] Find an instance in which an individual's name is flagged as an "unknown word", for example the line
- name: "Saasha Gilkes"in_guide-pages/how-to-set-reminders-in-slack.md - [x] Using https://cspell.org/configuration/patterns/ as a reference, add a configuration setting so that lines matching
- name:are excluded from spell checking - [x] Save the configuration file and confirm that instances such as
- name: "Saasha Gilkes"in_guide-pages/how-to-set-reminders-in-slack.mdare no longer flagged as "unknown word". - [x] Add and commit
cspell.jsonand prepare a Pull Request in the usual manner.
Resources/Instructions
https://cspell.org/configuration/patterns/
- This issue resulted from #7004
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, Size
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:
Hi @vanessasinam, 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 :)
Availability: Mon-Fri 1pm-5pm EST ETA: 06/27/2024
Progress: Completed. Awaiting review.