Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

heliapb
Copy link
Member

@heliapb heliapb commented Sep 12, 2025

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.


@heliapb heliapb force-pushed the feat/spell_check branch 3 times, most recently from f254328 to d81aa23 Compare September 12, 2025 18:30
@heliapb heliapb marked this pull request as ready for review September 12, 2025 19:22
@heliapb heliapb requested a review from a team as a code owner September 12, 2025 19:22
@simonpasquier
Copy link
Contributor

We had a discussion in the past on the topic
#3654
#3653

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 .github/workflows/cspell.json. Is it something that was tedious? Do you think that it will be a burden to maintain over time? Overall it could be a topic for the next office hours :)

@heliapb
Copy link
Member Author

heliapb commented Sep 16, 2025

We had a discussion in the past on the topic #3654 #3653

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 .github/workflows/cspell.json. Is it something that was tedious? Do you think that it will be a burden to maintain over time? Overall it could be a topic for the next office hours :)

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.

@simonpasquier
Copy link
Contributor

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.

Copy link
Contributor

@simonpasquier simonpasquier left a comment

Choose a reason for hiding this comment

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

As promised, we've discussed during the office hours with @heliapb and @yp969803. The conclusion is that we're going to try it and see if it brings value. Because it's not a required check and it only works on Markdown files, it shouldn't be noisy.

@simonpasquier simonpasquier enabled auto-merge (squash) September 22, 2025 11:20
Signed-off-by: Hélia Barroso <[email protected]>
Signed-off-by: Hélia Barroso <[email protected]>
auto-merge was automatically disabled September 22, 2025 11:25

Head branch was pushed to by a user without write access

@heliapb
Copy link
Member Author

heliapb commented Sep 22, 2025

As promised, we've discussed during the office hours with @heliapb and @yp969803. The conclusion is that we're going to try it and see if it brings value. Because it's not a required check and it only works on Markdown files, it shouldn't be noisy.

It is also reviewing yaml|yml as per files: "**/*.{md,yaml,yml}" - but I left it as that since yaml docs are updated from make so I think it should not be to hard to managed. Also for reference open-telemetry/opentelemetry-collector#12671

@simonpasquier simonpasquier merged commit 6907660 into prometheus-operator:main Sep 22, 2025
23 checks passed
@heliapb heliapb deleted the feat/spell_check branch September 22, 2025 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants