Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 931 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 931 Bytes

Setup

Current project Unity version 2020.2.1f1, remind me to update this if I ever change the project version.

Coding Style

Methods

  • Methods should follow PascalFormat
  • Always fully expand {}

Properties

  • Use a _ in front of all parameters in methods and constructors.

Comments

Use XML for Doxygen

/// <summary>
/// Hello world
/// </summary>

Creating a Pull Request

  1. Always test the application to see if it works as intended with no additional bugs you may be adding!
  2. State all the changes you made in the PR, not everyone will understand what you've done!

Generating Documentation

Make sure Doxygen is installed and added to your environment path.

Run .github/UPDATE-DOCUMENTATION.cmd after all your initial commits then push.

Documentation

Documentation can be found here.