Английская лексика: Разработка программного обеспечения · Управление версиями

Что значит commit message?

Значение и примеры · Разработка программного обеспечения

существительноеБазовый термин

commit message: сообщение коммита, описание коммита

Краткий текст о том, что и зачем меняет коммит; позднее коллеги используют его, чтобы понять историю кода.

Где и как употребляется

Распространённый стиль: короткая сводка в повелительном наклонении (Fix login timeout, а не Fixed), затем пустая строка и подробности. Многие команды используют соглашение Conventional Commits (feat:, fix:). Сообщения вроде update или wip считаются плохой практикой.

Примеры предложений

  1. Please write a clearer commit message; 'changes' doesn't tell us anything.

    Напиши более ясное сообщение коммита: слово changes ничего нам не объясняет.

    Общее слово не позволяет понять содержание изменения по истории.

  2. The commit message links to the ticket, so we know why the limit was raised.

    В сообщении коммита есть ссылка на задачу, поэтому понятно, зачем повысили лимит.

    Связь с задачей сохраняет мотив изменения в истории проекта.

Распространённые словосочетания

  • write a commit message
  • descriptive commit message
  • amend the commit message
  • commit message convention