search

QuantStack / quantstack.github.io

QuantStack website
https://quantstack.net
12 stars 45 forks source link

Configure `codespell` pre-commit hook for spell checking #152

Closed arjxn-py closed 2 months ago

arjxn-py commented 2 months ago

This PR introduces the codespell pre-commit hook to automatically check and fix spelling mistakes across the codebase. It also includes custom configurations for word corrections and exclusions. Discussed in #147

cc: @jtpio

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
quantstack-github-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 11, 2024 1:33pm
arjxn-py commented 2 months ago

I had to make the initial pass in b63372a manually, but I believe once .pre-commit-config.yaml is in master it should be automatically running on PRs.

arjxn-py commented 2 months ago

Since it doesn't work with pre-commit, should i try creating a custom workflow instead?

arjxn-py commented 2 months ago

Small comment / question: I guess contributors to this site will need to install pre-commit locally now? Maybe we should add it to the README?

Yes, it'd be nice to add a note for the same. Happy to do so. Thanks :)

arjxn-py commented 2 months ago

Done @jtpio

arjxn-py commented 2 months ago

Hi @jtpio, just a gentle ping.

HaudinFlorence commented 6 days ago

@arjxn-py Thanks for your PR