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

Add CONTRIBUTING.md #852

Closed ItsDrike closed 3 months ago

ItsDrike commented 3 months ago

Ah, I didn't even find that oops! I thought that would be end-user docs, and I was looking in the readme and CONTRIBUTING.md (which doesn't exist). I now see it is also in-repo at docs/pages/contributing.rst

Originally posted by @katrinafyi in https://github.com/py-mine/mcstatus/pull/849#issuecomment-2233052838

We could do what I do in mcproto and add CONTRIBUTING.md file that just contains a link to the contributing page in the docs. It is true that many potential contributors will just look for the CONTRIBUTING.md file and if they don't find it, they assume there isn't any contribution guide.