Увеличете репутацията си в Github с правилни съобщения за фиксиране

Вместо да пишете едноредов git коммит съобщения с ангажирам -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.

Съобщение за ангажиране

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

git commit --file commit.txt

Това е всичко! Надяваме се, че това ви помага да предоставяте по-стандартизирани и ясни съобщения за ангажиране на вашите последователи, като помага на вашия проект да придобие експозиция и помага на отворен код общността расте.

Кредит за изображение: Caleb White /Разпръскване