Skip to content
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

ci: configure codespell in pre-commit #1478

Merged
merged 3 commits into from
Jan 3, 2025

Conversation

IndexSeek
Copy link
Contributor

Following up with #1471 to detect spelling issues with pre-commit.

I went with adding a .codespellrc file to store the ignore-words-list. I think it's possible to configure this in the pyproject.toml as well. We could probably swap that out if desired.

@IndexSeek IndexSeek changed the title feat: configure codespell in pre-commit ci: configure codespell in pre-commit Dec 30, 2024
@kevinjqliu
Copy link
Contributor

@IndexSeek thanks for the PR. could you fix the lint issue by running make lint? also we need to add the apache license header to the new file .codespellrc

@IndexSeek
Copy link
Contributor Author

@IndexSeek thanks for the PR. could you fix the lint issue by running make lint? also we need to add the apache license header to the new file .codespellrc

You're welcome! Good catch, sorry, forgot to lint! I added the header to the file and resolved a few codespelling violations to get pre-commit to pass.

Copy link
Member

@hussein-awala hussein-awala left a comment

Choose a reason for hiding this comment

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

This looks perfect!

Nit: IMHO it would be better to move the ignore list to pyproject.toml if it’s possible, but let’s wait for committers’ reviews before moving it

Copy link
Contributor

@Fokko Fokko left a comment

Choose a reason for hiding this comment

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

This looks great, thanks @IndexSeek for raising this PR, and thanks @kevinjqliu and @hussein-awala for reviewing this 🚀

@Fokko Fokko merged commit f863c4e into apache:main Jan 3, 2025
8 checks passed
@IndexSeek IndexSeek deleted the codespell-precommit branch January 3, 2025 23:05
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.

4 participants