Коммиты и ветки

Коммиты

• {prefix} — префикс.
• {group} — определенная группа.
• {content} — название коммита.
• {file} — затронутый файл.
• {description} — описание коммита.
• {area} — область в файле.

ЕСЛИ:

• было затронуто много файлов одной группы, то можно добавить группу в название коммита: -{prefix} {group}: {file?} {content}.
• был затронут всего один файл, то следует писать следующим образом: -{prefix} {file}, {content}.
• было затронуто много изменений, но их нельзя добавить в отдельную группу, то можно воспользоваться ; (точкой с запятой) для разделения смысла.
• нужно добавить несколько префиксов, то добавляйте! -{prefix1}-{prefix2}-{prefix3}...
• у файла изменилось название, то нужно указать его старое и новое название: -rename {old-file} -> {new-file}.
• нужно пометить конкретную функцию/метод/класс/переменную/область в файле, то нужно использовать > и указать название области: -{prefix} {file} > {area}.

Префиксы:

• Всевозможные сокращения, также можно придумать свои префиксы, главное, чтобы они были ясны
• {rename} можно заменить на {up}

Название: -{prefix} {content}.

Описание:

{commit-name}


{description}

Примеры:

• АБОБА:
  • -aboba
• Одно-файловые коммиты:
  • -add style.css
  • -up auth-guard.service.ts
• Обычные коммиты:
  • -fix frontend/components
• Однословные коммиты:
  • -fix
• Групповые коммиты:
  • -up bad: added schema
  • -up fail: add correct example
• ВАЛЯ, ВИДИШЬ ТОЧКА С ЗАПЯТОЙ:
  • -up users router: users/ -> users/:id; -add PATCH /:id/follow; -fix

Ветки:

• {name} — название ветки
• {task} — выполняемое задание
• {issue} — номер решаемого issue
• Пробелы: -

Название ветки:

• {name}/{task}
• issue-{issue}/{name}--{task}

Пример:

• main/code-review
• issue-4/frontend--style-refactroring