Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cspell.json to ignore the text "Authy" #1078

Closed
7 tasks
t-will-gillis opened this issue Oct 27, 2024 · 0 comments
Closed
7 tasks

Update cspell.json to ignore the text "Authy" #1078

t-will-gillis opened this issue Oct 27, 2024 · 0 comments

Comments

@t-will-gillis
Copy link
Owner

Prerequisites

  1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our Getting Started page.
  2. Before you claim or start working on an issue, please make sure you have read our How to Contribute to Hack for LA guide.

Overview

We need to add the specified false positive term to the appropriate list in the Code Spell Checker configuration file cspell.json.

Action Items

  • You must use VS Code as your local text editor and install the Code Spell Checker extension. Code Spell Checker can be installed either using the VS Code text editor1 or the VS Code Marketplace website2.
  • Do not change any configuration settings or make any spell corrections.
  • Open the file cspell.json and locate the list named "ignoreWords": [ ]
  • Add / insert the text "Authy", on the first line of the list:
      "Authy",
  • Add to the front of the existing list- do not remove or replace any other list item.
  • Save cspell.json and then test the change by opening _guide-pages/2FA.html and confirming that no Code Spell Checker error/message related to "Authy" is displayed for this file.
  • Docker testing is not required. Create a Pull Request in the usual manner, with changes only to cspell.json.

Resources

  • This issue was created as part of # 5312

Footnotes

  1. Installing Code Spell Checker from the VS Code text editor

  2. Code Spell Checker - VS Marketplace

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: QA
Development

No branches or pull requests

1 participant