OSSU Game Project

Purpose

This project is here to help people in the OSSU program get their feet wet with a real project. We'll follow a lot of the normal process that you'd follow when writing code for a company.

Setup

We're using virtualenvs with Python 3.10, ensure you're using something similar:

python3 --version

To get started, create a virtual environment:

python3 -m venv .

Activate the virtual environment based on the operating system you're using. See the Python documentation on activating your venv for more details on how to activate it for your platform.

Once you're activated, install any requirements necessary:

pip install -r requirements.txt

That should have everything all set up. Just run the game:

python main.py

Coding

Remember that the project is here to help people learn what it's like on a real industry project. This means we'll follow patterns that are closer to how a company would run an internal repo rather than how open-source projects often work.

Contributing

To contribute:

• Join the OSSU Discord server and ping me (@Rob) to get access to the project.
• Grab an unclaimed issue in the issues section.
• If you need clarification, just ask.
• If you have an idea, feel free to create an issue for it, but get buy-in from @robbrit before spending a lot of time on it.
• Create a branch following the pattern <your Github username>/<description of change>.
• When you're done, send a pull request.

Before sending it though, ensure:

• You're following the formatting guidelines listed below.
• You're using mypy type annotations.
• You're following the style guide as defined below.
• You specify which issue you're completing.

What not to do:

• Use forks. The Github Actions that we use to validate code quality don't seem to run correctly on forks.
• Start coding before reaching out. We'd prefer to chat with you and have you join the conversation as part of a team rather than just some anonymous contributor.

PRs from forks

If you've done a PR from a fork, it's pretty easy to get your changes back into the main repo. When you create the PR from the fork, instead of choosing robbrit:main as the branch you want to merge to, type the name of a new branch (following the branch naming guidelines above) and then do it from there. That should be able to merge without any issues, and then you can create a PR from that into main.

Formatting

We're using black to format the code. Why? Because I don't like to argue about formatting. Just use the default settings.

Function Breaks

Sometimes black will format a multiline function call like this:

func(
    arg1, arg2, arg3
)

This is tricky to read. In order to get black to format this nicely, put a comma at the end:

func(
    arg1, arg2, arg3,
)

This will cause black to format it with one argument per line:

func(
    arg1,
    arg2,
    arg3,
)

Style

Use the Google Python Style Guide to style your code.

In the case of a conflict between black's defaults and the style guide, prefer the black version.

Note that reviewers may not know/remember the style guide 100%, so feel free to mention (with references) when a review comment violates it.