-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
A CI to check for grammer mistake in the .md
files
#1112
Comments
Would love to work on this |
would also love to work on this. |
@oliverdunk I like this idea, but I would like to see what rules this CI tries to enforce. We have to follow the Google style guide. Since style guides can vary, I want to make sure this doesn't just generate a lot of spam that we wouldn't be able follow. |
There's also a potential problem that we would always be asking external contributors to change things that the CI asked to do. This scenario creates more work for all of us. |
Yeah, following Joe's comment it would be nice if anyone wanting to work on this could propose a specific way they will approach it. For example, the libraries or style rules you intend to use. |
I was exploring and was thinking of using run check |
At a glance, that looks like something that would be likely to fall into the traps Joe mentioned (being too noisy, and not being setup for our specific style guide). I think the most interesting thing here would be definite spelling mistakes but I'm not sure that library supports that? |
Hey @oliverdunk i think this would fit it (codespell-action |
Describe the bug
We need to set up a GitHub Actions workflow to automatically check for grammar mistakes in our Markdown (.md) files. This will help ensure that our documentation and other textual content are clear and error-free.
Expected behavior
The CI should check for grammatical errors
Notes
Anything additional here. 🌈
The text was updated successfully, but these errors were encountered: