- скилл commit кодирует личный стиль сообщений: русский, опциональный scope-префикс, первая строка «что сделано», тело 1–3 пункта, без co-authored - плагин добавлен в marketplace.json и в секцию README
3.1 KiB
3.1 KiB
name, description
| name | description |
|---|---|
| commit | Оформить git-коммит в личном стиле проекта. Сообщение на русском, средняя детализация, опциональный scope-префикс, первая строка отвечает «что сделано», тело — списком 1–3 пункта, без co-authored. Использовать, когда нужно закоммитить изменения или сформулировать текст коммита. |
Коммит
Сообщение коммита на русском, лаконичное, но не пустое. Цель формулировки — чтобы через полгода можно было быстро найти изменение по области или по проблеме. Уровень конкретики средний: не абстрактно («правки», «фиксы»), но и не пересказ диффа построчно — достаточно, чтобы понять суть.
Первая строка
- Отвечает на вопрос что сделано — результатом, а не командой:
добавлены,изменён,обновлено,исправлен,удалено,переименованои т.п. - В начале опционально область изменения через двоеточие:
<scope>: <текст>. Scope — пакет, файл или подсистема (backlog:,readme.md). Если область очевидна или изменение размазано — можно без неё. - Английские термины, имена классов, функций, файлов — оставляем на английском, не транслитерируем и не переводим.
Тело (опционально)
- Нужно, только когда первой строки мало: неочевидное «почему», важная деталь, несколько разнородных изменений.
- Списком, 1–3 пункта. Не влезает в три — сигнал, что коммит стоит разбить.
- Та же средняя детализация, что и в заголовке.
Чего НЕ делаем
- Без
Co-Authored-Byи любых трейлеров-подписей. - Не пишем прозу по-английски (кроме терминов и имён).
- Не уходим в крайности — ни абстракция, ни построчный отчёт.
Примеры
backlog: добавлены задачи про загрузку
readme.md дополнен информацией об установке плагинов
исправлен баг с отображением источника
Разнородные изменения — не один коммит с длинным телом, а несколько коммитов, каждый со своей узкой первой строкой.