Ведення комітів
Для того, щоб спростити командну роботу в git, у проекті буде прийнято єдиний стиль запровадження коммітів. Дотримання єдиного стилю введення комітів має кілька переваг. По-перше, це спрощує розуміння історії змін у проекті, оскільки всі комміти будуть описані в одному стилі та в одному форматі. По-друге, це робить процес спільної роботи над проектом більш ефективним та організованим, оскільки всі учасники розумітимуть, які повідомлення коммітів очікуються.
Правила найменування коммітів
Будь-який коміт розділений на три частини:
- тип комміту
- коротке повідомлення комміту
- номер issue
<type>: <short summary> (#xxx)
│ │ │
│ │ └─> Номер issue.
│ │
│ └─> Підсумок у теперішньому часі.
| Без великої літери.
| Без крапки в кінці.
| Англійською мовою.
│
└─> Тип комміту: fix|feat|docs|refactor|build|ci
Тип комміту може бути такими:
- fix: виправлення помилки
- feat: нова функція
- docs: зміни лише в документації
- refactor: зміна коду, яка не виправляє помилку та не додає функції
- build: зміни, які впливають на систему збірки або зовнішні залежності
- ci: зміни в наших конфігураційних файлах і сценаріях CI
Кожен таск має свій issue, тому при створенні коміту потрібно вказувати, до якого issue відносяться зміни.
Приклади:
fix: fix bug with auth proccess (#1)
fix: add validation to data entering (#2)
feat: add auth logic to start (#3)
docs: update intallation instruction (#3)
build: add create link (#4)
ci: add auto releasing (#12)
Більше інформації
Даний вид ведення коммітів застосований у Angular і називається "Angular Conventional Commits", проте не є єдиним. Для різних проектів може бути свої правила. Застосовувані правила у цьому проекті дещо урізані для простоти засвоєння. Для більшої інформації перейдіть за посиланням.
У цьому проекті було прибрано scope, інструкції з введення body і footer комміту, прибрано обмеження на кількість символів.