Add a CI spell check job for changed files on PRs - #1255
Conversation
|
Hmm ok I had assumed that some warning would pop up that PR-triggered actions are not triggered here, but it seems not. The action does run on my forked repo though: jochem-brouwer#2 |
71d84b9 to
5a84e45
Compare
|
I think this is a great feature for the repo! I am not familiar with Also one extra function we do is to post a comment on the PR which points out exactly what words are misspelled instead of just failing the job. Might be good to trigger a comment here as well to make it easier to identify which words are causing the issue |
|
Thanks for the review, @taxmeifyoucan! @jochem-brouwer I agree that at least having the comment on the PR would be a nice addition for people to easily fix the typos. Could you please add that and then I'll merge this in? Thanks! |
|
Great suggestion! I'll add a GH comment in to dump the spelling mistakes (or in some cases false positives). I will also update to use this ethereum-based whitelist for words :) |
|
v good concept and still happy to merge once it's been revised but closing for now |
This PR adds a CI job which will run a
cspellcheck on only the changed files (as compared to master).As a proof of concept and to show how spell fails (and false positives) should be fixed I've included two files.
Some notes:
EIP,Holesky, etc.[//] # cSpell:words WORD_LIST, see: https://stackoverflow.com/a/20885980Attendeessection of the Meeting, wrap this in (names are obv. flagged as "spell error"):Note:
cspelldefaults to US English which is why "standardisation" is flagged on Meeting-202.Obviously open for discussion, but I think for now a spell check job on new files would be handy. On meeting-202 it found one obvious error:
eaps->EIPs. Have not checked the other files (besides throwing them in the cspell job, this obviously flags a lot of errors)