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 prose linter to CI #1572

Open
rht opened this issue Dec 30, 2022 · 8 comments · May be fixed by #2568
Open

Add prose linter to CI #1572

rht opened this issue Dec 30, 2022 · 8 comments · May be fixed by #2568

Comments

@rht
Copy link
Contributor

rht commented Dec 30, 2022

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)

@rht
Copy link
Contributor Author

rht commented Jan 3, 2023

@EwoutH any opinion on those prose linter tools?

@manvendra5345
Copy link

Hi everyone!
I am Manvendra Singh Solanki from Cse Ai-Ml background and i am also interested in working in this project , I know python , java , HTML , CSS . I can adapt very fast and have great learning capacity but these thing are common what i think i have different in me is that i want to learn from thoes who are better than me and catch up to them and even beat them and always keep learning.

I also want to contribute and learn but i am new to this platform please guide me .

Email:- [email protected]

@EwoutH
Copy link
Member

EwoutH commented Mar 8, 2024

@EwoutH any opinion on those prose linter tools?

Don't know it, pitch it to me :)

@fai-max
Copy link

fai-max commented Mar 21, 2024

Hey is this issue still open? I would like to try and work on it.

@rht
Copy link
Contributor Author

rht commented Mar 22, 2024

Yes, you can work on it. Vale is the one I have found to be used by multiple projects.

@sanika-n sanika-n linked a pull request Dec 24, 2024 that will close this issue
@sanika-n
Copy link

sanika-n commented Dec 24, 2024

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:)

@EwoutH
Copy link
Member

EwoutH commented Dec 24, 2024

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.

@sanika-n
Copy link

Thank you, will try to resolve them as soon as possible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants