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

feat: GitHub workflow Codespell #256

Merged
merged 4 commits into from
May 20, 2024

Conversation

vara-bonthu
Copy link
Contributor

Feature: Implement Codespell for Automatic Spell Checking

This pull request introduces a new GitHub workflow that leverages the Codespell tool to automatically check for spelling errors across our codebase.

Benefits:

  • Improved code quality and consistency by identifying potential typos and misspellings.
  • Early detection of spelling errors helps maintain a professional codebase.
  • Reduced time spent manually checking for spelling mistakes.

How to Use:

  • No manual intervention is required. Codespell will automatically run on the specified triggers and report any identified spelling errors in the pull request comments.
  • You can also run locally with the command pre-commit run -a from the root folder. You may have to install pre-commit locally

Signed-off-by: Vara Bonthu <[email protected]>
@@ -11,7 +11,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/log"
)

type Conainer struct {
type Container struct {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can revert this if this is going to cause an issue

@@ -59,7 +59,7 @@ func (f *FinchRuntime) ContainerWithPort(ctx context.Context, name string, port
return false, err
}

var containers []Conainer
var containers []Container
Copy link
Contributor Author

Choose a reason for hiding this comment

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

same as above

Copy link
Collaborator

Choose a reason for hiding this comment

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

Looks like these are all contained in this file only so I don't expect to run into any issues.

Copy link
Collaborator

@nabuskey nabuskey left a comment

Choose a reason for hiding this comment

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

I think it's nice that this catches and fixes typos (obviously we have a lot). Is it possible to exclude this check when determining if the PR passes overall checks?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this necessary? I just don't want to introduce another thing to manage.

Copy link
Contributor Author

@vara-bonthu vara-bonthu May 16, 2024

Choose a reason for hiding this comment

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

This setup is useful for contributors to run pre-commit locally before raising a PR to check for any spelling errors. We don't need to maintain this file as it doesn't require any changes.

.github/workflows/codespell.yaml Outdated Show resolved Hide resolved
@vara-bonthu
Copy link
Contributor Author

I think it's nice that this catches and fixes typos (obviously we have a lot). Is it possible to exclude this check when determining if the PR passes overall checks?

PR checks won't fail with the latest changes

Copy link
Collaborator

@nabuskey nabuskey left a comment

Choose a reason for hiding this comment

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

We have a lot of typos as shown by this PR and I think it's a good idea to have this. We should have this in the stacks repository as well. Especially when we move the examples directory to it.

Copy link
Contributor

@nimakaviani nimakaviani left a comment

Choose a reason for hiding this comment

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

LGTM

@nimakaviani nimakaviani merged commit a4e7fb7 into cnoe-io:main May 20, 2024
3 checks passed
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