CONTRIBUTING.md

Contributing Guidelines

In order to contribute to the project, you must follow these guidelines...

1. Follow PEP8 convention naming rules for C and Python
2. Lint your code with black
3. Please make an issue first before submitting a pull request
4. Always add unittests when you're introducing something new
5. For C code, try to use FASTCALL as much as you can
6. Make sure your code actually works before you submit a pull request
7. Please be patient when waiting for pull request reviews, we are all unpaid-volunteers

Build From Source

See below to see how to build pygame_geometry from source. If you need help, talk to us on Discord.

Windows 10 / Windows 11

1. Install Python 3.7+
2. Install Visual Studio Community 2022 or Visual Studio Build Tools 2017 and make sure you mark MSVC v140 - VS 2015 C++ build tools (v14.00) with the installation
3. Run python -m pip install setuptools -U
4. Install the latest version of git
5. Run git clone https://github.com/pygame-community/pygame_geometry.git
6. Run cd pygame_geometry; python -m pip install .

If you are having trouble re-compiling, try deleting the build folder from the root directory if it exists

MacOS

1. Install Python 3.7+
2. Install HomeBrew
3. Install dependencies

brew install sdl2 sdl2_image sdl2_mixer sdl2_ttf pkg-config

4. Run python3 -m pip install setuptools -U
5. Run git clone https://github.com/pygame-community/pygame_geometry.git
6. Run cd pygame_geometry; python3 -m pip install .

Linux (Debian-based Distributions)

1. Install Python 3.7+ (Should be provided in distributions based out of Debian 10 Buster or above)
2. Install dependencies

sudo apt install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev pkg-config -y

3. Install git by sudo apt install git -y
4. Run python3 -m pip install setuptools -U
5. Run git clone https://github.com/pygame-community/pygame_geometry.git
6. Run cd pygame_geometry; python3 -m pip install .