ci: add pre-commit config for codespell#147
Conversation
Vizonex
left a comment
There was a problem hiding this comment.
@pixelatedkisses Looks like a pretty good start let's make sure we add a workflow first so that this thing can edit these mistakes out and I would also recommend looking into cython-lint to lint the code.
|
@Vizonex Added the pre-commit CI workflow and the cython-lint hook as suggested. |
e8cf59f to
5348b80
Compare
|
@pixelatedkisses Nice work let's see what pre-commit has to say :) |
|
@pixelatedkisses git add winloop; git commit -m "fix cython code"And then let pre-commit do it's thing , although annoying to some (including me some times) this will help you get everything fixed immediately without wasting resources. |
|
@Vizonex, I pushed the latest fixes to the PR branch and |
|
@pixelatedkisses Thank you :) |
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