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

Чому важливі повідомлення комітів

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

Структура якісного повідомлення коміту

1. Лаконічність і зрозумілість

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

Bad: "Fixed a bug"
Good: "Fix issue with user authentication in login form"

2. Відокремлення теми від основної частини

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

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

Subject: "Add validation for user email input"

Body: "This commit introduces email format validation to ensure
that users provide a valid email address when registering. It
helps improve the overall data integrity of the system."

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

git commit

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

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

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

echo "Git is the most popular VCS in the world used by millions of developers since it allows efficient collaboration via committing, reverting and merging changes. Besides, Git is free and open source and can be easily installed on Windows, macOS, Linux and all Unix-based platforms." >> test.txt

Повідомлення коміту виглядає так:

Subject: "Add description of Git"
  
Body: "This commit introduces brief description 
of Git and highlights its key features. It also 
states the reasons for the widespread popularity 
of Git."

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

3. Використання наказового способу

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

Bad: "Fixed the issue with the login form"
Good: "Fix issue with user authentication in login form"