ci: add pre-commit config for codespell#147
Open
pixelatedkisses wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What do these changes do?
This PR introduces a
.pre-commit-config.yamlfile at the root of the repository to automate formatting, and spell checking. It sets up:trailing-whitespaceandend-of-file-fixerto keep repository formatting consistently clean.codespellhook: To automatically catch typos in code and documentation before commits are finalized.--ignore-words-listand folder exclusion pattern.Are there changes in behavior for the user?
This change is strictly restricted to the developer workflow and CI environment
Is it a substantial burden for the maintainers to support this?
No. It eliminates the need for maintainers to manually review and flag basic formatting errors during future PR reviews.
Related issue number
Relates to #144
Checklist