-
-
Notifications
You must be signed in to change notification settings - Fork 847
Closed
Labels
Complexity: Mediumfeature: spellingrole: back end/devOpsTasks for back-end developersTasks for back-end developerssize: 1ptCan be done in 4-6 hoursCan be done in 4-6 hours
Milestone
Description
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.jsonto 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: aymarmsbainguides-team.mdare no longer flagged as "Unknown word(s)". - Add and commit
cspell.jsonand prepare a Pull Request in the usual manner.
Resources/Instructions
- Previous issue Updated spell checker to ignore member's names #7073
- This issue resulted from ER: need to manage spell check false positives in markdown files #7004
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Complexity: Mediumfeature: spellingrole: back end/devOpsTasks for back-end developersTasks for back-end developerssize: 1ptCan be done in 4-6 hoursCan be done in 4-6 hours
Type
Projects
Status
Done