feat: pre-commit hook to correct spellings using codespell #191
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a pre-commit hook to correct the spellings of commonly used words. Words related to the technical domain are not modified by codespeller
pre-commit
hook has been introduced, such that each time the commandgit commit
is run, commonly used spellings are checked for correctness inrst
files onlypre-commit
hooks requires the installation of thepre-commit
in the local repositorypre-commit
and setup the environment are updated in the READMEThe following is an error reported by codespeller
The word
merge
is misspelled asmege
, in the file https://docs.moja.global/en/master/Guidelines/DeveloperWorkflow/bots_and_integrations.htmlThe changes are corrected and staged as shown below
Thanks for opening the Pull Request for moja global. Happy contributing ✨