Skip to content

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

Closed
wants to merge 2 commits into from

Conversation

candrews
Copy link

@candrews candrews commented May 2, 2023

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.

candrews added 2 commits May 2, 2023 14:29
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]>
@ack-prow ack-prow bot requested review from jljaco and RedbackThomson May 2, 2023 18:37
@ack-prow
Copy link

ack-prow bot commented May 2, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: candrews
Once this PR has been reviewed and has the lgtm label, please assign a-hilaly for approval by writing /assign @a-hilaly in a comment. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ack-prow ack-prow bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 2, 2023
@ack-prow
Copy link

ack-prow bot commented May 2, 2023

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

Copy link
Collaborator

@jaypipes jaypipes left a 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... :)

@candrews
Copy link
Author

candrews commented May 3, 2023

First, make a PR to the code-generator repository that updates the template Go code that contains these typos.

aws-controllers-k8s/code-generator#444

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.

aws-controllers-k8s/controller-bootstrap#21

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/test-infra#340

@jaypipes
Copy link
Collaborator

jaypipes commented May 3, 2023

Awesome, thanks @candrews. Gonna close this one out.

@jaypipes jaypipes closed this May 3, 2023
ack-prow bot pushed a commit to aws-controllers-k8s/controller-bootstrap that referenced this pull request May 3, 2023
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.
ack-prow bot pushed a commit to aws-controllers-k8s/code-generator that referenced this pull request May 3, 2023
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.
ack-prow bot pushed a commit to aws-controllers-k8s/test-infra that referenced this pull request May 17, 2023
* Add pre-submit PR action prow job for codespell
* chore: Fix spelling errors

Following up on aws-controllers-k8s/iam-controller#78
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants