Skip to content

Update spell check cspell.json to ignore members' github handles #7099

@t-will-gillis

Description

@t-will-gillis

Overview

We need to update the code spell check configuration file so that the spell checker excludes lines matching github-handle: from checking, in order to reduce the number of false positives ("unknown word"). Currently, specific GitHub handles are included only in the guides-team.md project, in the future all projects will include this information.

Action Items

  • Open guides-team.md in your IDE. Note that on this project, the github-handle: for many of the members has been provided (eg. line 24) and cSpell is flagging the member's handle as an "Unknown word".
  • Next, open the configuration file cspell.json in your IDE, and
  • refer to the CSpell reference esp. the Exclude/ Include Patterns for information on how to add to the configuration settings so that lines matching github-handle: are excluded from spell checking.
  • (Note: see link to 7073 below. This PR made similar adjustments to cspell.json to exclude lines beginning with - name:. The solution for this issue should be similar.)
  • Save the configuration file and confirm that instances such as github-handle: aymarmsba in guides-team.md are no longer flagged as "Unknown word(s)".
  • Add and commit cspell.json and prepare a Pull Request in the usual manner.

Resources/Instructions

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions