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(Spell check): Github action #131

Merged
merged 5 commits into from
Apr 2, 2024
Merged

🚥 ci(Spell check): Github action #131

merged 5 commits into from
Apr 2, 2024

Conversation

raxhvl
Copy link
Member

@raxhvl raxhvl commented Mar 30, 2024

closes #121

The action reviews markdown files from PRs targeting main branch. It leaves a comment with a list of typos and instructions on how to fix them.

For stability reasons, I have kept this simple by using GNU Aspell markdown mode instead of 3rd-part actions.

You could make an intentional typo in this PR to see it in action.

Checklist

  • Github action
  • PR template with instruction
  • Custom wordlist
  • Fixed existing typos

Preview

I have tested this on a private repo:

Screenshot from 2024-03-30 19-12-59

@eth-protocol-fellows eth-protocol-fellows deleted a comment from github-actions bot Mar 30, 2024
@raxhvl raxhvl marked this pull request as ready for review March 31, 2024 16:18
@raxhvl raxhvl self-assigned this Mar 31, 2024
@raxhvl raxhvl added the enhancement New feature or request label Mar 31, 2024
@taxmeifyoucan
Copy link
Contributor

Thanks a lot Rahul! Tested and all seems to be working fine.

@taxmeifyoucan taxmeifyoucan merged commit 7d097b0 into main Apr 2, 2024
1 check passed
@taxmeifyoucan taxmeifyoucan deleted the ci/spelling branch April 2, 2024 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🤖 CI(Spelling): Use github actions to highlight typos
2 participants