diff --git a/README.rst b/README.rst index fbec4c55a7..d983bbe561 100644 --- a/README.rst +++ b/README.rst @@ -149,7 +149,18 @@ Dependency versions: | SDL_ttf | >= 2.0.15 | +----------+------------------------+ +How to Contribute +----------------- +First of all, thank you for considering contributing to pygame-ce! It's people like you that make pygame-ce a great library. Please follow these steps to get started: +1. Read the `Contribution Guidelines`_ and the `Many Ways to Contribute`_ wiki pages. +2. Read the documentataion on `Opening A Pull Request`_ and `Opening a Great Pull Request`_. +3. Read how to `label and link reported issues`_. +4. Check the `issue tracker`_ for open issues that interest you or open a new issue to start a discussion about your idea. + +There are many more resources throughout the `wiki pages`_ that can help you get started. + +If you have any questions, please feel free to ask in the `Pygame Community Discord Server`_ or open an issue. License ------- @@ -192,6 +203,14 @@ See docs/licenses for licenses of dependencies. .. _Compilation wiki page: https://github.com/pygame-community/pygame-ce/wiki#compiling .. _docs page: https://pyga.me/docs .. _GNU LGPL version 2.1: https://www.gnu.org/copyleft/lesser.html +.. _Contribution Guidelines: https://github.com/pygame-community/pygame-ce/wiki/Contribution-guidelines +.. _Many Ways to Contribute: https://github.com/pygame-community/pygame-ce/wiki/Many-ways-to-contribute +.. _Opening A Pull Request: https://github.com/pygame-community/pygame-ce/wiki/Opening-a-pull-request +.. _Opening a Great Pull Request: https://github.com/pygame-community/pygame-ce/wiki/Opening-a-great-pull-request +.. _issue tracker: https://github.com/pygame-community/pygame-ce/issues +.. _label and link reported issues: https://github.com/pygame-community/pygame-ce/wiki/Labelling-&-linking-reported-issues +.. _Pygame Community Discord Server: https://discord.gg/pygame +.. _wiki pages: https://github.com/pygame-community/pygame-ce/wiki .. _简体中文: ./docs/readmes/README.zh-cn.rst .. _Français: ./docs/readmes/README.fr.rst