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

Contribution Section Added to README.rst #2910

Merged
merged 2 commits into from
Jun 14, 2024

Conversation

MrF1ow
Copy link
Contributor

@MrF1ow MrF1ow commented Jun 5, 2024

Why Change was Made

As previously stated, sifting through all the project docs to figure out how to contribute was a bit of a maze. It took some digging and hopping between wiki pages to find what I needed. After some good discussion, it was clear that the addition of another file such as CONTRIBUTING.md would be unnecessary and not for the pygame GitHub. However, even though the addition of a whole other file was not the right call, the need for a place that will guide new and existing contributors to the documentation in the wiki pages related to contributing was still there.

Why pygame CE should accept changes

If pygame CE accepts these changes, I know that it will speed-up the onboarding process for contributors, making it more inviting for new folks to jump in and for seasoned contributors to navigate with ease. Additionally, it will lessen the amount of questions people have about how to get started or where to find essential information. It is a win-win all around!

What I did

A small "How to Contribute" section was added to the README.rst. It provides a short and concise summary of where to find the documentation in the wiki pages about contributing to pygame-ce.

This pull request addresses the following:

@MrF1ow MrF1ow requested a review from a team as a code owner June 5, 2024 17:20
@ankith26 ankith26 added the docs label Jun 6, 2024
Copy link
Member

@oddbookworm oddbookworm left a comment

Choose a reason for hiding this comment

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

Overall, this looks like a good addition IMO. I'm in favor of it, but I do have one gripe that I would like to see corrected before I approve. Great job! 👏

README.rst Outdated Show resolved Hide resolved
Copy link
Member

@MyreMylar MyreMylar left a comment

Choose a reason for hiding this comment

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

OK, LGTM 👍

Thanks for bearing with all the feedback!

Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for contributing! 🎉

There are README rewrite ideas floating around, but I don't think that should stop this PR from getting merged for now. It's a good addition that the README mentions the wiki now, and the rewrite should keep that aspect in.

@ankith26 ankith26 dismissed oddbookworm’s stale review June 14, 2024 15:46

Changes requested in the review have been implemented

@ankith26 ankith26 added this to the 2.5.1 milestone Jun 14, 2024
@ankith26 ankith26 merged commit 75b0870 into pygame-community:main Jun 14, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants