Проверки перед коммитом, формат коммитов: метка + короткое название + тело с деталями. Правила: один коммит = одна тема, документация и комментарии на русском.
1.3 KiB
1.3 KiB
hello
Игра на Odin + raylib. Карты и тайлсеты экспортируются из Tiled в JSON.
Проверки перед коммитом
odin check . # компилируется без ошибок
Тесты (odin test .) — если трогал парсеры или игровую логику.
Коммиты
Формат: метка + короткое название, на русском:
feat: чтение параметров тайлсета из tiles.json
Метка — feat, fix, refactor, docs, chore, test. Название — императив, суть изменения.
В теле коммита — подробности: как работает, какие подводные камни.
- Один коммит = одна тема. Правка + тест едут вместе.
- Не описываем очевидное («фикс бага»), описываем что изменилось.
- Если фикс что-то ломал — можно вторую строку с «почему», но обычно не надо.
Прочее
- Вся документация и комментарии в коде — на русском.
- Табы (odinfmt.json), пакет один — main, файлы по темам: map, tiled_parser, entity.