8000 readme: add Contributing section by katrinafyi · Pull Request #851 · py-mine/mcstatus · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

readme: add Contributing section #851

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

Merged
merged 3 commits into from
Jul 19, 2024

Conversation

katrinafyi
Copy link
Contributor

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

this is just a signpost to the documentation page.
@ItsDrike
Copy link
Member
ItsDrike commented Jul 17, 2024

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
Copy link
Contributor Author

Sure! Moved into CONTRIBUTING.md now.

@PerchunPak PerchunPak linked an issue Jul 18, 2024 that may be closed by this pull request
@kevinkjt2000
Copy link
Contributor

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

@kevinkjt2000
Copy link
Contributor

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.

@kevinkjt2000 kevinkjt2000 reopened this Jul 18, 2024
Copy link
Contributor
@kevinkjt2000 kevinkjt2000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Details for contributing should be in one place

@katrinafyi
Copy link
Contributor Author
katrinafyi commented Jul 18, 2024

Yessir.

@kevinkjt2000 kevinkjt2000 merged commit 0ab8c4d into py-mine:master Jul 19, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md
4 participants
0