CONTRIBUTING

# CONTRIBUTING

This document outlines how to contribute to this sadistic repository.

## REQUIREMENTS

- Visual Studio Installer
  - Visual Studio 2017/2019/2022
  - Workload(s):
    - `Desktop development with C++`
  - Component(s):
    - Win7.1 SDK in `C++ Windows XP Support for VS 2017 (v141) tools [Deprecated]`
    - `Windows 10 SDK (10.0.19041.0)`
- Git w/ GitHub account for PRs
- Installation of Halo Custom Edition for debugging, testing

## FORMATTING

See [.editorconfig](./.editorconfig). Your editor will read this to understand the existing formatting style or adapt to the style present in each file.

------------

1. fork the github repository to your github account
2. clone your fork to your local development environment
3. carry out your hacks and commit them to your fork
4. create a pull request on the official fork repository

## STRUCTURE

The repository comprises of the following top-level directories:

|  directory   | description
|  ----------- | -------------------------------------------
|  .github     | files for github issues, workflows, etc.
|  .vscode     | synced exts, debug cmd, settings, tasks
|  bin         | compiled binaries and assets
|  doc         | documentation for hce discord rich presence
|  src         | discord rich presence source code