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

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

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

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

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

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

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

Добавлена ​​поддержка Docker, новая функция is_unique, а также исправлена ​​ошибка.
Добавлена ​​поддержка docker-compose и при необходимости обновлена ​​инструкция по установке. Также включена новая функция в функцию check_order () для проверки уникальности и исправлена ​​небольшая ошибка при создании ярлыков продуктов.
src / somedir / library.py: 381 - Добавлен параметр is_unique в функцию check_order ().
src / products.py: 194 - Исправлена ​​ошибка при создании ярлыка продукта.
docker-compose.yml - Добавлен файл docker-compose.
docs / install.md - Обновлено руководство по установке, в котором рассказывается, как установить через Docker.

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

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

git commit --file commit.txt

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

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