Add code spell task, fix issues and run the task in CI #1661
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dmathieu
requested review from
fbogsany,
mwear,
robertlaurin,
dazuma,
ericmustin,
arielvalentin,
ahayworth,
plantfansam,
robbkidd and
kaylareopelle
as code owners
|
The failing test appears unrelated. |
kaylareopelle
approved these changes
Aug 1, 2024
There was a problem hiding this comment.
Thanks for your contribution, @dmathieu!
codespell is new to me. CSpell was added to contrib to mimic what OpenTelemetry.io uses, but it looks like the OTel Go and Python projects both use this tool.
I don't think we need to use the same tool in contrib and core. CSpell is still pretty new to contrib, so maybe this is a good opportunity to see which one we prefer and align the two later.
That the .codespellignore is so short leans me toward this tool.
|
cspell is different. It checks for spelling errors in written text (documentation, markdown documents). That makes sense for opentelemetry.io, but not so much for a codebase. |
mwear
approved these changes
Aug 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds codespell to the project, which allows finding spelling issues within code.
It also fixes every spelling issue found, and runs the task within CI.