Contribution Section Added to README.rst #2910
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: