Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: pre-commit hook to correct spellings using codespell #191

Merged
merged 2 commits into from Jun 4, 2022

Conversation

Namyalg
Copy link
Member

@Namyalg Namyalg commented Jun 2, 2022

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

  • Issue reference: Feature Request: Correct spelling errors using a pre-commit hook #190
  • Peer reviewer: @HarshCasper @chicken-biryani @shubhamkarande13
  • Explain the changes: A pre-commit hook has been introduced, such that each time the command git commit is run, commonly used spellings are checked for correctness in rst files only
  • Dependency changes: The pre-commit hooks requires the installation of the pre-commit in the local repository
  • Documentation update: The steps to install pre-commit and setup the environment are updated in the README

The following is an error reported by codespeller

The word merge is misspelled as mege, in the file https://docs.moja.global/en/master/Guidelines/DeveloperWorkflow/bots_and_integrations.html

image

The changes are corrected and staged as shown below
image

Thanks for opening the Pull Request for moja global. Happy contributing ✨

@HarshCasper HarshCasper merged commit 76fe665 into moja-global:master Jun 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants