Как правильно сделать коммит в соответствии с правилами оформления коммитов?

Как можно выполнить коммит с типом fix, используя git commit -m? Как правильно отформатировать сообщение коммита, чтобы соответствовать спецификации типа?
  • 21 августа 2024 г. 15:33
Ответы на вопрос 4
Для того, чтобы сделать коммит в соответствии с правилами оформления коммитов, вам нужно использовать стандартные принципы оформления коммитов. Один из таких популярных стандартов - это Conventional Commits, который предлагает использовать следующий формат для сообщений коммитов:

<тип>[необязательная область охвата]: <сообщение>

где <тип> указывает на тип изменений (например, feat - для новой функциональности, fix - для исправления ошибки, docs - для изменений документации и т.д.), необязательная область охвата обычно указывает на файл или подсистему, которая была затронута изменениями, а <сообщение> содержит краткое описание сущности изменений.

Таким образом, чтобы сделать коммит с типом fix, используя git commit -m, вам нужно выполнить следующую команду:

git commit -m "fix: исправлена ошибка в модуле авторизации"

Или если исправление ошибки затрагивает конкретный файл:

git commit -m "fix(auth): исправлен баг с обработкой паролей"

Важно помнить, что корректное сообщение коммита поможет вам и вашим коллегам легче осуществлять отслеживание изменений, а также при необходимости быстро находить нужные коммиты в истории проекта.
Подставляешь вместо text , сообщение по переданному шаблону и все 

git commit -m '<тип>[необязательный контекст]: <описание>

[необязательное тело]

[необязательная(ые) сноска(и)]'


Либо пишешь все в редакторе - тогда -m 'text' не добавляешь, тебе вылезет редактор сообщения
Если пишешь в консоли, то просто убираешь последнюю кавычку и нажимаешь энтер - будешь писать дальше с новой строки до того, пока не поставишь кавычку снова перед очередным нажатием на энтер
Похожие вопросы