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

🐞 fix(Spell check): Spell check CI - false positives #146

Merged
merged 2 commits into from
Apr 4, 2024

Conversation

raxhvl
Copy link
Member

@raxhvl raxhvl commented Apr 4, 2024

Words with special character (hyphen) was added to the wordlist.txt.

Proof-of-stake
proof-of-stake
Proof-of-work
proof-of-work

Perhaps the contributor missed the warning from instructions. Now, this corrupted wordlist and is causing Aspell to fail within spell check CI workflow.

Screenshot from 2024-04-04 16-17-29

A bug in the CI workflow ignores Aspell errors, causing checks to pass when it shouldn't have.

This PR:

  • Fixes the bug. The CI fails if ASpell errors out for any reason.
  • Removes the hyphenated words that corrupted wordlist.
  • Fixes additional typos that slipped through due to this bug.
  • Introduces an enhancement: Camel case words are now recognized. No need to add them to wordlist!
  • Makes the warning about special characters more explicit.

Please consider merging this PR as soon as possible before more typos gets merged.

@taxmeifyoucan taxmeifyoucan merged commit 169910f into main Apr 4, 2024
1 of 2 checks passed
@taxmeifyoucan
Copy link
Contributor

I am sorry about the wordlist! Merged

@taxmeifyoucan taxmeifyoucan deleted the fix/spelling-ci-bug branch April 4, 2024 13:25
@raxhvl
Copy link
Member Author

raxhvl commented Apr 4, 2024

I am sorry about the wordlist! Merged

Oh no worries! The CI should have flagged it. All good now!

@raxhvl
Copy link
Member Author

raxhvl commented Apr 4, 2024

@taxmeifyoucan - There is one more fix required. Im pushing it shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants