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

Що означає 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