Giter VIP home page Giter VIP logo

ossu-game-project-1's Introduction

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

Contributing

To contribute:

  • 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.
  • Fork the repo to start working on your 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.

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.

ossu-game-project-1's People

Contributors

robbrit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.