Add pre-commit checks including codespell

neuroinformatics-unit / NeuroBlueprint

Lightweight data specification for systems neuroscience, inspired by BIDS.

http://neuroblueprint.neuroinformatics.dev/

Creative Commons Attribution 4.0 International

17 stars 1 forks source link

Add pre-commit checks including codespell #33

Closed niksirbi closed 9 months ago

niksirbi commented 9 months ago

This PR adds some basic pre-commit hooks, which also include codespell - a tool for catching commonly misspelt words. The codespell is configured in .codespellrc. If we run into problems with certain words going forward, we can whitelist them there. I also set up a codespell action to run as part of the docs building and deployment workflow, to avoid publishing with spelling mistakes.