Per #1180 (comment)

This is basically the version I used to generate that PR.

Note that I've pinned it to @v0.0.20 which is the latest release. GitHub best practices suggest pinning to the SHA instead of the tag.

As an aside, you probably want to configure dependabot to make PRs for github actions (it will definitely provide them for check-spelling).

The current model is that the workflow will comment on a push or a pull request. If there's an open pull request, it will try not to comment on the push. When it runs for a pull request, it will try to collapse the most recent pr comment. -- I'm currently investigating SARIF reporting which could change how things work (at least a little).

• Project page

Here's a sample of talking to the workflow to update the expect.txt file: check-spelling-sandbox#4 -- note that as configured, it explicitly will not offer this for the primary repository. Any workflow with the ability to write into a repository is a risk, and thus in order to reduce risks for popular repositories, I'm generally suggesting that if projects want to use this feature (which does make it easier for contributors to update this file, as opposed to running commands on their local computer), it not be enabled in the primary repository.

The README.md file is just for readers and not used by the project.

The candidates.patterns file isn't actually supported by 0.0.20 (but should be by the next version) -- it's used to make suggestions for adding entries into patterns.txt (or a future filename for the same feature).

It's probably worth reviewing the expect.txt file at least once to see if there are any items that jump out as false negatives = errors that should be corrected.

If you run into problems, you can @ me. I'm fairly responsive.