-
Notifications
You must be signed in to change notification settings - Fork 3.8k
feat: add spell check workflow #7909
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: add spell check workflow #7909
Conversation
f254328
to
d81aa23
Compare
d5b1f97
to
91b80a3
Compare
894ab0f
to
8f250e4
Compare
We had a discussion in the past on the topic The previous decision was to do nothing because some maintainers had not-so-good experience with similar solutions. I'm not sold one way or another and cspell seems not too noisy. I see that you needed to put lots of exceptions in |
it was a bit tedious, but at the same time the errors it gave at first pretty much wrote the list of words to add to cspell.json, and then was just a question of reviewing those how seemed typos or words to the list. And honestly once is done probably will just require adding some words from time to time. But I can add this pr to discussion for the next office hours. |
Thanks! To reiterate, I'm favorably impressed how the tool caught a lot of misspells (with your help too of course) but it would be good to hear from other maintainers before committing. |
1f82b89
to
de1bccf
Compare
80a7fab
to
ba2240d
Compare
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.
Signed-off-by: Hélia Barroso <[email protected]>
Signed-off-by: Hélia Barroso <[email protected]>
Head branch was pushed to by a user without write access
ba2240d
to
fbd4703
Compare
It is also reviewing yaml|yml as per |
Description
Following #7872 would be good to have automatic spell check.
Type of change
What type of changes does your code introduce to the Prometheus operator? Put an
x
in the box that apply.CHANGE
(fix or feature that would cause existing functionality to not work as expected)FEATURE
(non-breaking change which adds functionality)BUGFIX
(non-breaking change which fixes an issue)ENHANCEMENT
(non-breaking change which improves existing functionality)NONE
(if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)Verification
Please check the Prometheus-Operator testing guidelines for recommendations about automated tests.
Changelog entry
Please put a one-line changelog entry below. This will be copied to the changelog file during the release process.