search

py-mine / mcstatus

A Python library for checking the status of Minecraft servers
https://mcstatus.readthedocs.io
Apache License 2.0
478 stars 37 forks source link

readme: add Contributing section #851

Closed katrinafyi closed 3 months ago

katrinafyi commented 3 months ago

This is just a signpost to the documentation page, if you would like it.

ItsDrike commented 3 months ago

Whoops, I didn't yet notice this when opening #852 (GitHub on phones sucks). That said, I think it's a better idea to just create CONTRIBUTING.md and add this link there, like I mentioned in that issue.

README is something that most people will be interested in reading and it doesn't really need to contain contributing information, as most regular people aren't really interested in that. I also think that even for potential contributors, it will be easier to just look there than searching for it in readme.

katrinafyi commented 3 months ago

Sure! Moved into CONTRIBUTING.md now.

kevinkjt2000 commented 3 months ago

Thanks for doing this, but uhhh we already have contributing docs. https://github.com/py-mine/mcstatus/blob/master/docs/pages/contributing.rst

kevinkjt2000 commented 3 months ago

I see this was requested for catering to people that might only look for this file without seeing other docs and give up. I suggest only a link to the file and nothing else. If there needs to be more about poetry it would go in the file we already have.

katrinafyi commented 3 months ago

Yessir.