Watts-Lab / deliberation-topics

Collection of deliberation topics and infrastructure for measuring their properties
MIT License
0 stars 1 forks source link

Add Spellcheck to GitHub Actions #15

Closed JamesPHoughton closed 2 years ago

JamesPHoughton commented 2 years ago

We need to add a spellchecker to the deliberation-topics GitHub actions to check our topic documentation for spelling errors.

Task List:

isaacgat commented 2 years ago

Kimberly and I found a spellcheck action online: https://github.com/rojopolis/spellcheck-github-actions and worked to add it to the repo. After a bit of toying around with the parameters, we got it to work and were able to fix our spelling errors and add some unique words to the word library. In the end, our topic markdowns passed the spellcheck.

Important: we learned that we need to include URL's in an HTML tag in the README.md so we could exclude anything within an HTML tag from the spellcheck. This made it so words without spaces were not being unnecessarily flagged by the spellcheck.