Contributing

Contributions are welcome. If you would like to improve popgames, please follow the workflow below.

1. Fork and clone the repository

Fork the repository on GitHub, then clone your fork locally:

git clone https://github.com/<your-username>/popgames.git
cd popgames

Create a new branch for your changes:

git checkout -b your-feature-branch-name

2. Set up the development environment

This project uses uv for dependency and environment management.

Install uv if it is not already installed:

pip install uv

Install the development environment with:

uv sync

This installs the package together with the default dependency groups used for development and documentation.

The repository also uses a Taskfile to define common development commands. The Task runner (go-task) is installed automatically as part of the development dependencies.

3. Run the test suite

Before submitting a pull request, ensure all tests pass:

uv run task test

4. Format and check the code

Please ensure your code is properly formatted and passes all checks before opening a pull request:

uv run task format
uv run task check

5. Submit a pull request

Push your branch to your fork and open a pull request against the main repository.

Please include:

  • A clear description of the changes

  • Any relevant issue references

  • Tests for new functionality when applicable

  • Documentation updates if needed

Development notes

  • Keep contributions focused and minimal.

  • Follow the existing project structure and coding style.

  • Run formatting, linting, and tests locally before submitting your pull request.