openmodelingfoundation.github.io icon indicating copy to clipboard operation
openmodelingfoundation.github.io copied to clipboard
verified publisher icon openmodelingfoundation

GitHub Action for Spell Check of PR mods

Open crvernon opened this issue 4 years ago • 4 comments

It would be nice to have a GitHub Action in place to conduct a spell check for documents modified upon PR.

crvernon avatar Dec 06 '21 18:12 crvernon

An excellent suggestion. Any experience with existing GH action spell checkers? I found this list on cursory search:

  • https://github.com/check-spelling/check-spelling
  • https://github.com/TypoCI/spellcheck-action
  • https://github.com/rojopolis/spellcheck-github-actions

From https://github.community/t/github-action-for-spell-check-on-a-pull-request/116738/2 it looks like check-spelling might be the closest to a recommended solution

alee avatar Dec 06 '21 18:12 alee

I haven't done this before but I agree it looks like check-spelling would be the one that would get the job done.

crvernon avatar Dec 06 '21 18:12 crvernon

a github action for automatically linting / formatting our markdown would be great too

alee avatar Dec 08 '21 23:12 alee

@alee this looks promising: https://github.com/marketplace/actions/markdown-linting-action

crvernon avatar Dec 09 '21 19:12 crvernon