-
Notifications
You must be signed in to change notification settings - Fork 917
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 prose linter to CI #1572
Comments
@EwoutH any opinion on those prose linter tools? |
Hi everyone! I also want to contribute and learn but i am new to this platform please guide me . Email:- [email protected] |
Don't know it, pitch it to me :) |
Hey is this issue still open? I would like to try and work on it. |
Yes, you can work on it. Vale is the one I have found to be used by multiple projects. |
Hi, Sanika here, I just created a pull request which hopefully addresses this issue.. I integrated vale into the CLI workflow and configured it so that vale gets triggered anytime anyone pushes code or submits a PR, this is my first time contributing in mesa, so pls let me know if it is alright:) |
Thanks for the PR. I looked into it a bit, and I think a prose linter seems useful, and Vale looks like it's the most commonly used one and actively developed. So I support adding it, if it doesn't add too much overhead to our processes. So go ahead, I left some more technical feedback in the PR. |
Thank you, will try to resolve them as soon as possible |
What's the problem this feature will solve?
We currently use codespell, but we could have a more uniform documentation style with a prose linter.
Describe the solution you'd like
One possible solution is using Vale. But there are other alternatives as well.
Additional context
See projectmesa/mesa-examples#14 (comment)
The text was updated successfully, but these errors were encountered: