Contribution Guide

If you're interested in submitting code to this gamemode, read this guide carefully.

Required Tools

Setup Instructions

  1. Download Visual Studio Code.
  2. Go to extension tab in VScode and install OverPy extension.
  3. Clone the repository to your local computer (use GitHub Desktop if you don't know how to clone using terminal).
  4. Open cloned repository folder on VS Code.
  5. Try building gamemode using instructions below.
  6. Follow general workflow to start development.

Building

For instructions on how to use OverPy, see here

  1. Compile main.opy using the compiling instructions at OverPy Wiki.
  2. Open a custom game in Overwatch.
  3. Paste the compiled gamemode code.

General workflow

  1. Find an issue to fix (or submit one yourself).
  2. Create new branch dedicated to that issue.
  3. Modify codebase using VScode. Be sure to follow styling guidelines.
  4. Compile and test new codebase.
  5. Commit working changes.
  6. Submit Pull Request (PR) to merge your branch into dev branch.
  7. Wait for owner to approve and merge your Pull Request.

Release Cycle

Coding Style Guidelines

This codebase follows Python's PEP 8 style guide since OverPy follows Python syntax.


Revision #1
Created 21 June 2024 16:33:45 by Admin
Updated 20 August 2024 22:38:14 by Admin