-
Notifications
You must be signed in to change notification settings - Fork 48
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
Fix typos #326
Fix typos #326
Conversation
Skipping CI for Draft Pull Request. |
This PR is motivated by the fix openstack-k8s-operators/lib-common#231
d080325
to
47e441e
Compare
@gibizer: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Have you considered adding some tooling for this kind of check, like the 'misspell' linter from golangci-lint? It can check all committed files and report the most common misspellings. It also has an ignore option if we want to avoid correction of some words. I ran it locally and got quite similar results.
im warey of addign tooling for spelling as it will disproportionately affect me. we could try it but to me typos in code comments are not a reason to reject a patch. if it does not affect the functioning of the code it is not a bug or code quality issue. we could try it but if its makes it significantly harder for me to work on this repo i would like to be able to remove it in the future. |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: gibizer, SeanMooney The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sure, I understand what you mean. I have the same issue (it's even more noticeable in Polish). I saw that the tool has an autocommit option, so in theory it can correct errors automatically, but I haven't tested it yet. If this check is annoying, I'll drop the question. |
I have a spell check plugin in vscode locally but my reason of this change wasn't to fix typos in code / code comments, but to fix typos in external facing messages, like our condition status messages. That could be seen by the end user and having typos there is a marketing thing, I guess. :) But then I get carried away and fixed the code typos as well for consistency. My experience with automatic spell checking is that it needs a project / codebase specific allowlist to not being a blocker, and keeping that allow list sane is annoying. Bottom line: If having an automated spellcheck with a manually maintained allowlist is not a burden then lets go for it, but I afraid it will be. |
This PR is motivated by the fix openstack-k8s-operators/lib-common#231
Depends-on #280 (merged)