Closed yarikoptic closed 9 months ago
@neuroinformatics-unit/neuroinformatics-all this looks nice, shall we add it to the cookiecutter template itself (and by extension, other repos)?
I'm in favour of it. We are already using it on some of our other repos anyway.
Happy with it too.
Just FYI: ARC colleagues recommend their usage but agreed not to add it to their cookiecutter template, due to false positives and it sometimes breaking their code. I have no experience using it as a pre-commit though.
FWIW it is always a good practice to review pre-commit's changes. But indeed in case of a "heavy" pre-commit changes (black etc) it might be tricky... but in this case it doesn't even apply
so the worst effect from false-positive - inability to commit until white-listing that particular hit one way or another.
Thanks @yarikoptic. I'll raise a seperate PR to make it part of the template itself.
Description
Fix and prevent future common typos using https://github.com/codespell-project/codespell
Let me know if you want to add support for codespell into the template
Why is this PR needed?
Typos are there and more might sneak in
What does this PR do?
adds pre-commit and github workflow (let me know if I should remove) and fixes some typos
Checklist: