Я полагаю вы уже знакомы с git. Чтобы не привело вас сюда, добро пожаловать и надеюсь найдете все, что вам необходимо знать.
Кратко о Git
У нас есть большие проекты, в которые мы коммитим, Git помогает разработчикам управлять различными коммитами и объединять их в единое целое. Он также помогает контролировать версии проектов, являясь системой контроля версий. Это странное определение, но это лучший способ, которым я мог объяснить Git.
Обычно когда говорят о Git имеют в виду DevOps инструмент для управления исходным кодом. Это бесплатная, с открытым исходным кодом система контроля версий для маленьких и очень больших проектов.
Прежде чем продолжить, я рекомендую вам немного ознакомиться с рабочим процессом git здесь
Git коммиты
Коммиты Git представляют собой снимок (snapshot) текущего этапа/состояния кода проекта. Это позволяет системе поэтапно сохранять изменения.
Коммиты используются для отслеживания изменений в проекте во времени, а также помогают выделить основные стадии проекта. Коммиты можно применить для отслеживания производительности и KPI команды.
Промышленный стандарт коммитов Git
Я предпочитаю называть это как git коммиты. Они не должны фиксировать сообщения с очень сложными терминами, должны быть читаемыми и понятными людям, которые незнакомы с кодом.
Почему важно стандартизировать коммиты
Важность заключается в том, чтобы по вашему комментарию к коммиту можно было понять, какие изменения были сделаны. Это также должно помочь новым участникам проекта лучше понять смысл коммитов. Вы должны знать зачем человек его сделал и какие последствия это вызовет.
Ваш комментарий к коммиту должен быть:
Понятным
Достаточным
Однозначным
Прежде чем создать комментарий к коммиту, вы должны подумать:
Зачем я добавил этот коммит
Какие изменения вносит коммит
Необходимы ли изменения
Решают ли изменения какую-либо проблему или он ссылается на какие-либо внешние ссылки или часть кода
Промышленный стандарт написания комментария к коммиту, который мы будем рассматривать:
<type>[optional scope]: <description>
[optional body]
[optional footer]
Различные стандартизированные типы коммитов представлены ниже:
fix: коммит, который устраняет баг
feat: коммит, который содержит новый функционал
chore: коммит, который не устраняет баг и не вносит новый функционал, а модифицирует или обновляет зависимости
refactor: этот коммит содержит рефакторинг, который включает рефакторинг кода или изменения
docs: этот коммит изменяет документацию, readme.md или markdown файлы.
style: коммит, который вносит изменения в оформление кода
test: коммит, который изменяет тестовый файл, включая изменения
perf: коммит, в котором улучшается производительность
ci: коммит, в котором содержатся изменения в интеграции CI в файлах или скриптах
build: это файлы, которые включают файлы сборки и зависимости
revert: коммит, который сигнализирует об откате к предыдущему коммиту
Например:
feat: Добавление кнопки вывода средств на домашней странице
Вы также можете добавлять в коммиты разные эмодзи, которые относятся к определенным типам. Подробно здесь.
🐛: Исправлена контактная форма
✨: Добавление кнопки вывода средств на домашней странице
Заключение
Умение полученное в этой статье прокачают вас и сделают вашу кодовую базу более организованной. Это важно для фиксации и отслеживания изменений, которые вы вносите.
Когда ваш код становится легаси кодом и новый разработчик работает с ним, комментарий к коммиту облегчит ему задачу понимания кодовой базы, даже когда вас нет рядом.
Если у вас есть предложения как улучшить коммиты, прошу поделиться в комментариях ниже.
Я надеюсь мы все узнали что-то из этой статьи, как улучшить наши комментарии к git коммитам.