projectmesa / mesa

Mesa is an open-source Python library for agent-based modeling, ideal for simulating complex systems and exploring emergent behaviors.
https://mesa.readthedocs.io
Apache License 2.0
2.4k stars 867 forks source link

Add prose linter to CI #1572

Open rht opened 1 year ago

rht commented 1 year ago

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 https://github.com/projectmesa/mesa-examples/pull/14#issuecomment-1364454346

rht commented 1 year ago

@EwoutH any opinion on those prose linter tools?

manvendra5345 commented 6 months ago

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:- singhmanvendra2003@gmail.com

EwoutH commented 6 months ago

@EwoutH any opinion on those prose linter tools?

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

fai-max commented 6 months ago

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

rht commented 6 months ago

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