Skip to content

Latest commit

 

History

History
16 lines (14 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

16 lines (14 loc) · 1.51 KB

CONTRIBUTING GUIDE

Общие положения:

  1. Функции возвращающие что-то кроме void пишутся в camelCase: bool example().
  2. Функции возвращающие void пишутся: void Example().
  3. Переменные (базовые типы, объект класса) и пишутся в snake_case: u8 example_variable = 69.
  4. Константы пишутся в UPPER_SNAKE_CASE: const u32 EXAMPLE_CONSTANT = 69.
  5. Фигурные скобки пишем на новой линии после описания функции (не void Example(){, а под ней).
  6. Соблюдаем общий стиль табуляций в коде, лишние пробелы/табы стараемся убрать.

Расположение файлов:

  1. Стараемся соблюдать ванильную иерархию расположения скриптов, если мы изменяем/дополняем ванильный код;
  2. Новые блобы располагать в соответствии с ванильной иерархией расположения скриптов;
  3. Новые системы мода располагаем в директории Modules (Modules/nameModule);
  4. Скрипты, несущие исключительно утилитарную функцию, располагаем в Utilites;

Данные правила касаются так же графики, звука, музыки и прочего.