Skip to content

Add pre-commit hooks for spell checking #378

Closed

Description

Problem

We don't have Git hooks to check for spelling mistakes in code or in commit messages.

Description

pre-commit has several hooks that could provide this check. Visit https://pre-commit.com/hooks.html and filter by the words 'spell' or 'typo' to see a list of options. Finding a popular, maintained one in the list and using it would improve the spelling situation considerably.

Alternatives

Relying on spell check by our IDEs and text editors is okay but it doesn't always work. Just yesterday, I made a commit called "Update pacakges" even though my IDE showed a wavy underline under the word.

References

Here are some of the most starred options from pre-commit's list:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Labels

good first issueNew-contributor friendlyhelp wantedOpen to participation from the community✨ goal: improvementImprovement to an existing user-facing feature📄 aspect: textConcerns the textual material in the repository🟩 priority: lowLow priority and doesn't need to be rushed🧱 stack: mgmtRelated to repo management and automations

Type

No type

Projects

  • Status

    ✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions