@arzamas-nick

Как правильней всего писать сообщения в команде /git comit -m""?

Допустим есть блок:

<div class="block">
    <div class="block__element1">1</div>
    <div class="block__element2">2</div>
  </div>


Затем я добавляю к этому блоку еще один элемент:

<div class="block">
    <div class="block__element1">1</div>
    <div class="block__element2">2</div>
    <div class="block__element3">3</div>
  </div>


Предположим что:
1-ый эл. это заголовок,
2-ой эл. это изображение,
и 3-ий эл. это описание (текст).

Я не совсем понимаю как правильно написать коммит чтобы понятно было и мне и другим. Писать в комитах непосредственно то что сделано в коде (какие изменения сделаны в редакторе), или же писать как эти изменения отобразятся визуально ?

Например:
1 вариант: Добавляет элемент block__element3 блоку block;
2 вариант: Добавляет текст с описанием блоку block;
  • Вопрос задан
  • 275 просмотров
Решения вопроса 1
jcmvbkbc
@jcmvbkbc
"I'm here to consult you" © Dogbert
Обычно в хорошем описании можно выделить две части. Одна описывает зачем это изменение нужно: в чём была проблема/чего не хватало/что работало не так. Вторая описывает решение и документирует, почему именно это решение было выбрано.
И это правило работает в обе стороны: если невозможно описать зачем было сделано изменение или почему оно именно такое -- это скорее всего плохое изменение.

1 вариант: Добавляет элемент block__element3 блоку block;
2 вариант: Добавляет текст с описанием блоку block;

Оба в равной мере бесполезны, как и сам этот коммит, судя по всему.
Ответ написан
Пригласить эксперта
Ответы на вопрос 2
@Iloveski
Jira или аналоги используете? Если да, то номер задачи оттуда пишите обязательно. А так, лучше писать на более высоком уровне, объяснять зачем были сделаны изменения в коде, то есть, ближе вариант 2.
Ответ написан
@Vitsliputsli

Я не совсем понимаю как правильно написать коммит чтобы понятно было и мне и другим.

Что-то типа этого:
"PROJ-237. Добавлено описание продукта на странице 'О товаре'"
и если позволительно, то лучше на английском. PROJ-237 - номер задачи в вашей любимой системе управления проектами.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы