pre-commit hook for codespell #579
Conversation
|
This seems reasonable, but I have one discussion point. The rest of our pre-commits use I could see either side, either updating it to match the behavior of the pre-commits or leaving it to manual correction to prevent unexpected changes of purposeful non-standard spellings. |
|
I think current/future work will probably include some jargon specific words that automatically changing will cause unexpected errors once committed that could be confusing to try and fix after the fact. yapf auto formatting isn't likely to impact behavior but changing a word in a string or variable name could. I included an update in the contributing guide about how to handle jargon words to pass this pre-commit stage |
Sounds good to me! |
* pre-commit hook for codespell, spelling fixes * update release-notes.rst
PR Summary
Closes #578
PR Checklist
General
closes #XXXto the PR description where XXX is the number of the issue.docs/release-notes.rstin a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecatedprecommit. To set up on your local, runpre-commit installfrom the top level of the repository. To manually run pre-commits, usepre-commit run --all-filesand re-add any changed files before committing again and pushing.