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

Add a spell and grammar checker in GitHub actions #19

Open
nmenon opened this issue Oct 26, 2024 · 3 comments
Open

Add a spell and grammar checker in GitHub actions #19

nmenon opened this issue Oct 26, 2024 · 3 comments

Comments

@nmenon
Copy link
Contributor

nmenon commented Oct 26, 2024

In addition, please add a spelling and grammar checker.
Example:
https://blog.alta3.com/topics/scm-and-pipelines/adding-spell-checking-as-a-github-action/ or the equivalent.

While at it request adding it to build check flow and contribute guide

@StaticRocket
Copy link
Member

Without a tuned wordlist enchant with https://github.com/sphinx-contrib/spelling reports about 6589 errors just for OS=linux DEVFAMILY=AM62X . This ignores grammar and contextual information, often tagging directories, build options and other parameters incorrectly.

I'm debating about trying to get something more advanced like merging languagetool so it's more context aware, but even that will have a lot of false positives. Not sure this is something we want to add right now.

@cshilwant
Copy link
Member

@StaticRocket Probably we can add it just for commit message?
Though I'm anticipating false alarms there as well

@StaticRocket
Copy link
Member

This is a can of worms I'm not prepared to open right now. I'm personally prioritizing cicd builds and rstcheck fixes first.

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

No branches or pull requests

3 participants