Skip to content

Commit 00f0c57

Browse files
authored
Merge pull request pygame#4120 from son1ong/pygamefinalb1
README.rst: Improve contributing section and formatting
2 parents 1d5aef0 + 7a1853e commit 00f0c57

File tree

1 file changed

+22
-29
lines changed

1 file changed

+22
-29
lines changed

README.rst

+22-29
Original file line numberDiff line numberDiff line change
@@ -74,38 +74,43 @@ locally, it'll launch the online website instead.
7474

7575
The online documentation stays up to date with the development version
7676
of pygame on GitHub. This may be a bit newer than the version of pygame
77-
you are using. To upgrade to the latest full release, run
77+
you are using. To upgrade to the latest full release, run
7878
``pip install pygame --upgrade`` in your terminal.
7979

8080
Best of all, the examples directory has many playable small programs
8181
which can get you started playing with the code right away.
8282

83-
Pygame is a powerful library for game development, offering a wide
84-
range of features to simplify your coding journey. Let's delve into
83+
84+
Features
85+
----------
86+
87+
Pygame is a powerful library for game development, offering a wide
88+
range of features to simplify your coding journey. Let's delve into
8589
what pygame has to offer:
8690

87-
Graphics: With pygame, creating dynamic and engaging graphics has
91+
Graphics - With pygame, creating dynamic and engaging graphics has
8892
never been easier. The library provides simple yet effective tools for
89-
2D graphics and animation, including support for images, rectangles,
93+
2D graphics and animation, including support for images, rectangles,
9094
and polygon shapes. Whether you're a seasoned game developer or just
9195
starting out, pygame has you covered.
9296

93-
Sound: Pygame also includes support for playing and manipulating sound
97+
Sound - Pygame also includes support for playing and manipulating sound
9498
and music, making it easy to add sound effects and background music to
95-
your games. With support for WAV, MP3, and OGG file formats, you have
99+
your games. With support for WAV, MP3, and OGG file formats, you have
96100
plenty of options to choose from.
97101

98-
Input: Pygame provides intuitive functions for handling keyboard, mouse,
102+
Input - Pygame provides intuitive functions for handling keyboard, mouse,
99103
and joystick input, allowing you to quickly and easily implement player
100104
controls in your games. No more struggling with complex input code, pygame
101105
makes it simple.
102106

103-
Game Development: Lastly, pygame provides a comprehensive suite of tools
104-
and features specifically designed for game development. From collision
107+
Game Development - Lastly, pygame provides a comprehensive suite of tools
108+
and features specifically designed for game development. From collision
105109
detection to sprite management, pygame has everything you need to create
106110
exciting and engaging games. Whether you're building a platformer, puzzle
107111
game, or anything in between, pygame has you covered.
108112

113+
109114
Building From Source
110115
--------------------
111116

@@ -123,25 +128,13 @@ on the `Compilation wiki page`_.
123128

124129
Contribute
125130
----------
126-
| Thank you for thinking of contributing!
127-
|
128-
| To contribute to the main `project documentation <https://www.pygame.org/docs/>`_, see ``docs/README.md`` or view more detailed instructions `here <https://github.com/pygame/pygame/tree/main/docs>`_.
129-
|
130-
| New to contributing to Open Source Free Libre software?
131-
| There is a draft of `"Let's write a unit test!" <http://renesd.blogspot.com/2019/11/draft-2-of-lets-write-unit-test.html>`_ which is a step by step guide on how to write your first unit test in Python for pygame, which is very similar to how you would do it for other projects.
132-
|
133-
| Want or need to compile pygame from source?
134-
| `See the compilation page <https://www.pygame.org/wiki/Compilation>`_ for more detailed instructions.
135-
|
136-
| For a detailed developer guide on "How to Hack Pygame":
137-
| Head to the `Hacking Page <https://www.pygame.org/wiki/Hacking>`_.
138-
|
139-
| Beginner developers looking for ways to contribute to the project can look at issues labeled `"good first issue" <https://github.com/pygame/pygame/labels/good%20first%20issue>`_ or `"Difficulty: Easy" <https://github.com/pygame/pygame/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A+Easy%22>`_.
140-
|
141-
| To submit patches and report bugs:
142-
| Visit the `Bugs & Patches <https://www.pygame.org/wiki/patchesandbugs>`_ page for detailed instructions.
143-
|
144-
| `See the info page <https://www.pygame.org/wiki/info>`_ for more info and ways to get in touch with the Pygame team.
131+
132+
* `Documentation Contributions <https://github.com/pygame/pygame/tree/main/docs>`_ - Guidelines for contributing to the main documentations
133+
* `Writing your first unit test <http://renesd.blogspot.com/2019/11/draft-2-of-lets-write-unit-test.html>`_ - Step by step guide on how to write your first unit test in Python for Pygame.
134+
* `How to Hack Pygame <https://www.pygame.org/wiki/Hacking>`_ - Information on hacking, developing, and modifying Pygame
135+
* `Issue Tracker for beginners <https://github.com/pygame/pygame/labels/good%20first%20issue>`_ - A way for beginners to contribute to the project
136+
* `Bugs & Patches <https://www.pygame.org/wiki/patchesandbugs>`_ - Report bugs
137+
* `Communication tools <https://www.pygame.org/wiki/info>`_ - More information and ways to get in touch with the Pygame team
145138

146139

147140
Credits

0 commit comments

Comments
 (0)