CODE_OF_CONDUCT.md

Соглашение о коммитах

Данное соглашение - простое соглашение о том, как нужно писать сообщения коммитов. Оно описывает простой набор правил для создания понятной истории коммитов, а также позволяет проще разрабатывать инструменты автоматизации, основанные на истории коммитов. Данное соглашение основано на оригинальном Соглашении о коммитах и совместимо с Семантическим Версионированием, описывая новые функции, исправления и изменения, нарушающие обратную совместимость в сообщениях коммитов.

Сообщения коммитов должны иметь следующую структуру: тип(контекст): описание Тип и описание - обязательные элементы. Контекст указывать необязательно. Так же, коммит может иметь несколько контекстов, перечисляемых через запятую.

Типы коммитов

• add: добавление нового функционала.
• fix: исправление бага/ошибки в коде или других элементах.
• hotfix: срочное исправление бага/ошибки в коде или других элементах. Применяется только в основной (master) ветке.
• tweak: изменение существующего функционала.
• remove: удаление существующего функционала или других элементов.
• refactor: изменения в коде, которые не исправляют ошибки и не добавляют новый функционал.
• style: изменения, не влияющие на функционал кода (отступы, форматирование и т.п.).
• docs: изменения касающиеся документации.
• revert: откат изменений другого коммита. Должен содержать тот же контекст и описание, что и у отменяемого коммита.
• wip: незавершенные изменения в коде.

Контексты

• git - изменения, не влияющие на код, но затрагивающий другие элементы репозитория.
• tools - изменения, затрагивающие вспомогательные инструменты проекта.
• src - изменения, затрагивающие код игры.
• ui - изменение затрагивающие интерфейс игры.
• map - изменение затрагивающие карты игры.
• proto - изменения, затрагивающие прототипы (.yml).
• texture - изменение затрагивающие текстуры игры.
• lang - изменения, касающиеся локализации.

Примеры

Коммит без контекста

• docs: Корректные формулировки в Чейнджлоге
• style: Новые файлы перенесены в нашу папку

Сообщение коммита с контекстом

• add(proto): Добавлен рецепт супа из опилок
• fix(src): Фикс невозможности отправить сообщение

Как делать НЕ надо

• Добавлено веселье
• add(src, proto, texture, ui, lang): Добавлена хирургия
• remove, add(src): Удалена команда fuckrules и добавлена команда adminwho