Spelling Is Next to Godliness

Spelling and grammar are very important. However, when in a rush, we tend to neglect these important aspects. Search engines and humans readers usually don’t appreciate content that includes spelling or grammatical errors.

This notion also applies to your code repository…

As such, let’s automatically spell check and fix our codebase with misspell!

Spell Check

cd my-code-repository/
~/bin/misspell -w .
git commit -am "fixed spelling"
  • -w: Overwrite file with corrections

Note: Be careful with overzealous fixes! You should review the changes before pushing, as:

  • 3rd-party libraries often have many issues
  • Localization files may be incorrectly flagged
  • The package maintainer might not appreciate such a large commit

Examples Pull Requests

Nicholas Nadeau, Ph.D., P.Eng.
Nicholas Nadeau, Ph.D., P.Eng.
Project Director

Nicholas Nadeau is the project director at Halodi Robotics, leading their mission of bringing safe and capable humanoid robots to everyone.