Is your feature request related to a problem? Please describe.
Currently, there is no mechanism in place to test the correctness of word spellings.
Describe the solution you'd like.
I propose to use https://github.com/codespell-project/codespell as a pre-commit hook. codespell rectifies the spellings of commonly used words on running git commit. Once the spellings are corrected, the changes need to be staged and committed again.
Describe alternatives you've considered
The initial idea was to use vale-action. vale can be used to lint the documentation and ensure it adheres to a particular style. However, due to its complexity, this is put on hold for the moment.
Is your feature request related to a problem? Please describe.
Currently, there is no mechanism in place to test the correctness of word spellings.
Describe the solution you'd like.
I propose to use https://github.com/codespell-project/codespell as a pre-commit hook.
codespellrectifies the spellings of commonly used words on runninggit commit. Once the spellings are corrected, the changes need to be staged and committed again.Describe alternatives you've considered
The initial idea was to use
vale-action. vale can be used to lint the documentation and ensure it adheres to a particular style. However, due to its complexity, this is put on hold for the moment.