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.
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.mdwould 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: