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

ci: add automated spellcheck for PRs #3989

Closed

Conversation

tay1orjones
Copy link
Member

@tay1orjones tay1orjones commented Mar 28, 2024

This PR adds an automated spell check to the website. The spell check will be ran on .md/.mdx files before you commit locally and also in ci on every pull request.

cspell-allowed-words.txt is a list of allowed words.

⚠️ This PR is not ready to merge until every spell check error has been fixed.

To help fix errors you can:

  1. Pull this PR down locally via the gh cli
  2. Run yarn lint:spellcheck
  3. Observe the errors and correct each one
  4. Commit the changes with the --no-verify flag:
    • git commit -a -m "my commit message here" --no-verify
  5. Push up the changes

If a word/spelling should be allowed, add it on a new line to cspell-allowed-words.txt

Please review all the words in cspell-allowed-words.txt as well to determine if there are any in there that shouldn't be allowed.

Changelog

New

  • added cspell for automated spell checking

Copy link

vercel bot commented Mar 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
carbondesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 28, 2024 7:20pm

@tay1orjones
Copy link
Member Author

The dev team discussed this today. Previous experience with this tooling on other projects was that the false positive rate from this tooling is very high. Maintaining the ignore/allow list was more expensive than any "savings" in spell checking through ci like this. Also anecdotally in those projects due to the high false positive rate most commits were being committed with --no-verify.

Due to this we're going to close this and make the recommendation to instead do spellcheck on a local level by installing a plugin to your IDE, like Code Spell Checker for vscode

@tay1orjones tay1orjones closed this Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants