Skip to content

Fix all actual typos and use .codespellrc to skip others #519

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 1 commit into from
Apr 12, 2025

Conversation

ottok
Copy link
Contributor

@ottok ottok commented Apr 11, 2025

Fix all spelling errors found by codespell[1] version 2.4.1.

No changes to "ALTER HEIRARCHY" in drivers/qtype.go.

[1] https://github.com/codespell-project/codespell/

@kenshaw
Copy link
Member

kenshaw commented Apr 11, 2025

I appreciate the work done to find typos, but as there's only one in the README.md, and the others are trivial, I don't really know what the point of merging this is. This is also a Go project -- as such, I see no reason to add a configuration file to the root that is longer than all the other changes combined. I understand that this is the configuration for the tool you used, but I would never run that tool again on the codebase, nor do I believe anyone else would.

@ottok
Copy link
Contributor Author

ottok commented Apr 12, 2025

Would you like me to remove the .codespellrc and just submit the typofixes?

Lintian in Debian was complaining about typofixes, so I had a need to fix them.

No changes to `"ALTER HEIRARCHY"` in `drivers/qtype.go`.
@ccoVeille
Copy link

I agree with @kenshaw having a configuration file for a tool that won't be used later, or only by a few people is somehow a problem.

But, while I state with the same things, my conclusion and suggestion would be different.

I would like to suggest to add the GHA codespell-action to the CI

https://github.com/codespell-project/actions-codespell

I often set it up when I also jump into a project to fix typos.

So here, I would agree with the idea to either have:

  • a PR that only fixes the typos and don't commit the codespell configuration file
  • a PR that fixes the typos, includes the codespell configuration file, and sets up the GHA codespell-action
  • one PR with the typos fixes and another PR to set up the GHA and so include the configuration file

@ottok
Copy link
Contributor Author

ottok commented Apr 12, 2025

I already updated this PR to have the typofixes only. I don't use GitHub code actions myself, so I won't invest time in building one. Feel free to use the .codespellrc from a previous version in this PR if you later need it.

@ccoVeille
Copy link

This is a good compromise.

@ottok please let me know if you have interest for adding such GitHub action

@ottok
Copy link
Contributor Author

ottok commented Apr 12, 2025

I don't use GitHub code actions myself, so I won't invest time in building one.

@ccoVeille
Copy link

I should have been clearer. I was suggesting I could help if @kenshaw wants me to look at it.

@kenshaw kenshaw merged commit d1ce6f0 into xo:master Apr 12, 2025
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