-
Notifications
You must be signed in to change notification settings - Fork 38
Fix spelling errors and add codespell github action #78
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
Conversation
Signed-off-by: Craig Andrews <[email protected]>
Use codespell to spell check the code and documentation. Correct spelling is a great way to look more professional and demonstrate higher quality. And it catches a surprisingly number of actual errors, too. See: https://github.com/codespell-project/codespell Signed-off-by: Craig Andrews <[email protected]>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: candrews The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Hi @candrews. Thanks for your PR. I'm waiting for a aws-controllers-k8s member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
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.
Hi @candrews thank you for your PR!
Unfortunately, there are dozens of ACK controllers, and they are all generated :) So, what you will want to do to incorporate your changes is to make PRs to a couple different repositories.
First, make a PR to the code-generator repository that updates the template Go code that contains these typos.
Second, for the ATTRIBUTION.md typos, you will want to make changes to the controller-bootstrap repository which is used to generate that ATTRIBUTION.md document.
Finally, if you'd like to add spellchecking to the GH Actions workflows that the controllers use, the test-infra repository that contains the replicated Prow jobs that each service controller repository uses for pre-submit PR actions. You would want to add that there... :)
aws-controllers-k8s/code-generator#444
aws-controllers-k8s/controller-bootstrap#21
|
Awesome, thanks @candrews. Gonna close this one out. |
Correct spelling is a great way to look more professional and demonstrate higher quality. And it catches a surprisingly number of actual errors, too. Following up on aws-controllers-k8s/iam-controller#78 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Spell checking done using codespell. Correct spelling is a great way to look more professional and demonstrate higher quality. And it catches a surprisingly number of actual errors, too. Following up on aws-controllers-k8s/iam-controller#78 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
* Add pre-submit PR action prow job for codespell * chore: Fix spelling errors Following up on aws-controllers-k8s/iam-controller#78
Fix spelling errors in docs and comments
Use codespell to spell check the code and documentation.
Correct spelling is a great way to look more professional and
demonstrate higher quality. And it catches a surprisingly number of
actual errors, too.