Skip to content

Configure codespell pre-commit hook for spell checking #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 18, 2024

Conversation

arjxn-py
Copy link
Member

@arjxn-py arjxn-py commented Sep 7, 2024

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

Copy link

vercel bot commented Sep 7, 2024

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 arjxn-py changed the title Configure codespell hook Configure codespell pre-commit hook for spell checking Sep 7, 2024
@arjxn-py
Copy link
Member Author

arjxn-py commented Sep 7, 2024

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.

Copy link
Member

@jtpio jtpio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @arjxn-py for looking into this!

Left a small comment, looks good otherwise,

@arjxn-py
Copy link
Member Author

arjxn-py commented Sep 9, 2024

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

Copy link
Member

@jtpio jtpio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

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?

@arjxn-py
Copy link
Member Author

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
Copy link
Member Author

Done @jtpio

@arjxn-py arjxn-py requested a review from jtpio September 12, 2024 22:24
@arjxn-py
Copy link
Member Author

Hi @jtpio, just a gentle ping.

Copy link
Member

@jtpio jtpio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jtpio jtpio merged commit a290367 into QuantStack:master Sep 18, 2024
4 checks passed
@HaudinFlorence
Copy link
Member

@arjxn-py Thanks for your PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants