Skip to content

update spell check config file to ignore members' names #7010

@roslynwythe

Description

@roslynwythe

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

  • Open the configuration file cspell.json in your IDE
  • 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
  • Using https://cspell.org/configuration/patterns/ as a reference, add a configuration setting so that lines matching - name: are excluded from spell checking
  • Save the configuration file and confirm that instances such as - name: "Saasha Gilkes" in _guide-pages/how-to-set-reminders-in-slack.md are no longer flagged as "unknown word".
  • Add and commit cspell.json and prepare a Pull Request in the usual manner.

Resources/Instructions

https://cspell.org/configuration/patterns/

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions