Повідомлення Комміту

Чому Повідомлення Комміту Мають Значення

Повідомлення комміту відіграють вирішальну роль у розумінні історії проєкту. Добре складені повідомлення полегшують співробітникам, майбутнім розробникам і навіть вам самим розуміння цілі і контексту кожної зміни. Чітка історія коммітів полегшує співпрацю, налагодження та процес визначення конкретних змін у часовому графіку проєкту.

Структура Хорошого Повідомлення Комміту

1. Стислість і ясність

Повідомлення комміту має бути стислим і чітким. Воно повинно чітко передавати мету комміту в одному рядку. Уникайте двозначності і надавайте достатньо інформації, щоб зрозуміти зміну без необхідності дивитися на реальний код.

2. Відокремлюйте Тему від Тіла

Якщо потрібна додаткова інформація, відокремте тему від тіла повідомлення про фіксацію порожнім рядком. У темі слід коротко описати зміну, а в тілі можна надати додатковий контекст, причини зміни і будь-яку відповідну інформацію.

Давайте розглянемо приклад такого повідомлення комміту:

Однак у цьому випадку ми просто виконаємо команду git commit без прапорця -m:

Буде відкрито текстовий редактор для Git за замовчуванням, де ви зможете написати детальне повідомлення комміту. Потім вам слід зберегти його і вийти з текстового редактора відповідним чином.

Давайте зробимо ще один комміт у нашому репозиторії:

Ось команда, яку ми використали для модифікації нашого текстового файлу:

Повідомлення комміту наступне:

Якщо ви не можете редагувати файл, натисніть клавішу i. Це забезпечить перехід у режим редагування. Знову ж таки, щоб зберегти зміни і вийти з Vim, натисніть клавішу Escape і дві великі літери Z.

Примітка

Якщо у вас встановлено інший текстовий редактор для терміналу (відмінний від Vim), і у вас виникли труднощі, ви можете легко знайти інформацію про те, як зберегти зміни і вийти з нього, в інтернеті.

3. Використовуйте Наказовий Спосіб

Пишіть повідомлення про фіксацію в наказовому способі, що дає відчуття напрямку змін. Починайте тему з дієслова, наприклад, "Fix", "Add" або "Update."