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

codespell: workflow, config, typos fixed #139

Merged
merged 5 commits into from
May 8, 2023

Conversation

yarikoptic
Copy link
Contributor

While listening to @elezar giving a presentation, decided to check the CDI out: Having typos free code would be very useful for 1.0 release ;)

elezar
elezar previously approved these changes May 4, 2023
Copy link
Contributor

@elezar elezar left a comment

Choose a reason for hiding this comment

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

Thanks @yarikoptic. lgtm

@klihub @bart0sh any objections?

.codespellrc Outdated
@@ -0,0 +1,4 @@
[codespell]
skip = .git,*.pdf,*.svg
# BU - part of JP3t17pCcGlemwknint6hfoeCVQrEMVwxRLRjXpq+BU=
Copy link
Contributor

Choose a reason for hiding this comment

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

@yarikoptic as someone who is not too familiar with codespell what does this represent?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

in this comment I am listing why we need to exclude BU -- you can find it by the end of that string and you have this string in the codebase somewhere.

Copy link
Contributor

Choose a reason for hiding this comment

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

This string is in a go.sum file. Does it not make more sense to add *.sum to the skip list?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

indeed, done!

@bart0sh
Copy link
Contributor

bart0sh commented May 5, 2023

/lgtm

@elezar elezar self-requested a review May 5, 2023 09:46
@elezar elezar dismissed their stale review May 5, 2023 09:46

Open quesiton regarding codespell config.

@yarikoptic
Copy link
Contributor Author

merged main, resolved conflicts

Copy link
Contributor

@elezar elezar left a comment

Choose a reason for hiding this comment

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

Thanks for the explaination. Please rather add go.sum and go.mod to the skip list instead of handling the checksum as a word.

.codespellrc Outdated
@@ -0,0 +1,4 @@
[codespell]
skip = .git,*.pdf,*.svg
# BU - part of JP3t17pCcGlemwknint6hfoeCVQrEMVwxRLRjXpq+BU=
Copy link
Contributor

Choose a reason for hiding this comment

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

This string is in a go.sum file. Does it not make more sense to add *.sum to the skip list?

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Copy link
Contributor

@elezar elezar left a comment

Choose a reason for hiding this comment

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

lgtm

@elezar elezar merged commit 40168a3 into cncf-tags:main May 8, 2023
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.

None yet

3 participants