Skip to content

Spell checker CI + typo corrections #292

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

Closed
vickybesra opened this issue Feb 9, 2025 · 7 comments · Fixed by #358
Closed

Spell checker CI + typo corrections #292

vickybesra opened this issue Feb 9, 2025 · 7 comments · Fixed by #358
Assignees
Labels
automated issue kind/bug Something isn't working kind/enhancement New feature or request

Comments

@vickybesra
Copy link
Contributor

Reason/Context

To improve code quality and maintain consistency in documentation, comments, and user-facing messages, we need to integrate a spelling checker into our Continuous Integration (CI) pipeline. This will help catch common typos and ensure better readability across the codebase.

Description

  1. Automatically detect spelling errors in documentation, comments, and code (where applicable).
  2. Fail the CI pipeline if errors are found, or provide warnings depending on severity.
  3. Ensure the spell checker runs efficiently without affecting CI performance.

Implementation ideas

Use a tool like typos, codespell, or hunspell for spell checking.

@vickybesra
Copy link
Contributor Author

@yada @lbroudoux I am working on this

@yada
Copy link
Member

yada commented Feb 11, 2025

I look forward to it, @vickybesra, as yes, we have "many" typos issues that should have been blocked on check... +1

@divyansh-prks
Copy link
Contributor

Hey @vickybesra may i know what is the update of this issue ?

@vickybesra
Copy link
Contributor Author

I'm working on this.. will open a PR soon

@yada yada added kind/bug Something isn't working automated issue labels Feb 23, 2025
@vickybesra vickybesra changed the title Add Spelling Checker in CI Typo Correction Feb 23, 2025
@vickybesra vickybesra changed the title Typo Correction Reflect the typo corrections Feb 23, 2025
@vickybesra vickybesra changed the title Reflect the typo corrections Spell checker CI + typo corrections Feb 23, 2025
@yada
Copy link
Member

yada commented Mar 18, 2025

@vickybesra to merge this, I think #358 is too big and will be hard to merge all at once...

So can you:

  1. Close corrected typo errors using spell checker #358
  2. Create a new PR to add the spell check GitHub action only on each new commit (test it locally)
  3. Create PRs to solve all typos reported by check; it is easier to create a PR by pages or group of pages instead of all typos on the website (re-use the .wordlist.txt file from corrected typo errors using spell checker #358 as it is fine)

3/ could become a community effort as all new commits will not be merged if the check failed (thanks to 2/)

Thank you

@yada yada closed this as completed in #358 Apr 22, 2025
@yada
Copy link
Member

yada commented Apr 22, 2025

I removed the GitHub action from #358 and merged all typo corrections in the documentation, thanks @vickybesra
So point 3/ in the comment above is ✅

I'm creating a new PR regarding point 2/ (dedicated to the spell check GitHub action)

@yada
Copy link
Member

yada commented Apr 22, 2025

All done and merged now.
Action is in place to follow up on the next website updates.

@yada yada closed this as completed Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automated issue kind/bug Something isn't working kind/enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants