Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (17 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

29 lines (17 loc) · 1.55 KB

Contributing

This file will contain some general guidelines for contributing as well as setup that will be added to over time.

Setup

You'll need HEMTT in your path. See the HEMTT Book - Installation for how to do this.

Once it's installed, you can copy the tasks.template.json file and rename it to .vscode/tasks.json to have some helpful tasks that you can run in the terminal.

SQF

  1. Keep variables immutable.
  2. If you must mutate a variable, name it _mut_<varName>.
  3. Prefer not to call remoteExec directly. Instead, add a new function that does the behavior you want to operate with and pass the data to it via targeted event handlers.

Naming

  1. Folders should be named in snake case, e.g. loadout_migration.
  2. Folders should always be named in lowercase, due to quirks with Windows.
  3. PAA files should be suffixed with their type based on Texture Map Types.

Docs

Check out the Docs Folder for a collection of various info pieces that seemed useful to have internally; there's also some info on the Wiki.

Other Standards

Make sure you read through the BIKI page on Code Optimization and the ACE3 wiki's Coding Guidelines. We don't follow either of these strictly, but they can provide a guideline for where to start.