Анатомия правильного коммита Link to heading
- type: тип коммита
- scope: краткое описание участка кодовой базы, заключенное в круглые скобки, за которыми следуют двоеточие и пробел
- description: краткое описание изменений в коде
- body: более длинное описание коммита, предоставляющее дополнительный контекст изменений. Должно быть помещено на одну пустую строку после описания
- footer: сноски должны содержать только ссылки на дополнительные вопросы, касающиеся изменений
Типы коммитов Link to heading
- build: изменения, связанные с процессами или инструментами сборки
- feat: коммит типа fix исправляет баг в вашем коде (соответствует PATCH в Cемантическом Версионировании)
- fix: коммит типа feat добавляет новую функцию в ваш код (соответствует MINOR в Cемантическом Версионировании)
- chore: регулярное обслуживание или административные задачи
- docs: изменения, связанные с документацией
- style: изменения, которые не влияют на функциональность кода (например, форматирование кода)
- refactor: модификация кода без изменения его поведения (рефакторинг)
- test: добавление или изменение тестов
Примеры Link to heading
Ниже приведены два ресурса как практический пример использования «Соглашения о коммитах»:
Webstorm / PhpStorm Link to heading
Плагин для Webstorm, доступный по ссылке Conventional Commit. Целью плагина является обеспечение автокомплита для «Соглашений о коммитах», также называемых семантическими коммитами, в диалоге VCS Commit.
VSCode Link to heading
Для редактора VSCode также имеется плагин Conventional Commits. Поможет заполнить сообщение коммита в соответствии со спецификацией «Соглашения о коммитах». Имеется поддержка gitmojis - на сайте можно быстро и удобно подобрать нужный вариант эмоджи для текущего коммита.