Ways to Contribute#

We would love to have you contribute to the project! There are several ways that you can do so.

How to contribute without coding#

  • Community - Post your projects, code, screen-shots, and discuss the Arcade library on the Python Arcade SubReddit.

  • Try coding your own animations and games. Write down notes on anything that is difficult to implement or understand about the library.

  • Suggest improvements - Post bugs and enhancement requests at the Github Issue List.

How to contribute code#

First, take some time to understand the project layout:

Then, perform the following steps:

  1. Make sure you have Python 3.9+ installed rather than 3.8+ to meet dev tool requirements.

  2. Make a virtual environment.

  3. Run pip install -e .[dev] to perform a dev install.

Afterwards, you can improve these parts of the project:

  • Document - Edit the reStructuredText and docstrings to make the Arcade documentation better.

  • Test - Improve the unit testing.

  • Code - Contribute bug fixes and enhancements to the code.