Awesome Reviewers

Verification · Hygiene · Spelling

Prose spell check

Dictionary check over docs and comments with a project word list.

How to build it

  1. Run codespell over docs and comments in the repository.
  2. Keep domain words in a project word list such as cspell.json words or a .codespellrc ignore-words-list.
  3. Run the check in pre-commit and in CI on every pull request.

Signals in a repository

  • A .codespellrc or cspell.json file listing project words.
  • A codespell or cspell hook in .pre-commit-config.yaml.

In practice

22 repositories run a tool for this check in the scanned set.

  • codespell · 22 repos

Examples