Повысьте репутацию на Github с помощью правильных сообщений о фиксации

Вместо того, чтобы писать однострочные сообщения git commit с параметром commit -m , в этой статье вы узнаете, как писать правильные сообщения фиксации. Правильные сообщения о фиксации важны, так как они позволяют другим точно видеть, что вы изменили, облегчая другим пользователям следить за вашим проектом, помогая расширить ваше присутствие в сообществе открытого исходного кода.

Напишите правильное сообщение о фиксации

Вместо того, чтобы включать сообщение фиксации в команду терминала, откройте свой любимый текстовый редактор с пустым файлом. Сообщение должно соответствовать следующему формату:

• Первая строка – это заголовок, резюмирующий весь коммит.
• После пустой строки следующая или несколько строк должны содержать любое читаемое описание, необходимое для фиксации. Это может быть сколько угодно долго.
• Все следующие строки должны суммировать точные изменения, внесенные в код в таком формате:
  • Имя файла: Строка № – Краткое описание модификации.

Пример сообщения о фиксации

Ниже показан пример сообщения фиксации:

 
Added Docker support, new is_unique feature, plus bug fix.
 Added support for docker-compose and updated installation instruction as necessary. Also included a new feature within check_order() function to check for uniqueness, and fixed small bug when creating product slugs.
 src/somedir/library.py:381 -- Added 'is_unique' parameter to the check_order() function.
 src/products.py:194 -- Fixed bug when creating product slug.
 docker-compose.yml -- Added docker-compose file.
 docs/install.md -- Updated installation guide to include how to install via Docker.

Сообщение фиксации

Теперь при фиксации вместо сообщения -m используйте параметр –file . Например, если имя файла вашего сообщения фиксации – commit.txt, вы должны выполнить команду:

 git commit --file commit.txt

Вот и все! Надеюсь, это поможет вам предоставить вашим подписчикам более стандартизированные и четкие сообщения о фиксации, что поможет вашему проекту получить известность и поможет развитию сообщества с открытым исходным кодом .

Кредит изображения: Калеб Уайт / Unsplash