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

Question

[arzamas-nick]

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

<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;

Comments

[eeiaao]

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

Предположим, что стоит классы называть семантично, а не block_elementN.

[arzamas-nick]

eeiaao, я на скорую руку, а так разумеется...

Answer 1

[jcmvbkbc]

Обычно в хорошем описании можно выделить две части. Одна описывает зачем это изменение нужно: в чём была проблема/чего не хватало/что работало не так. Вторая описывает решение и документирует, почему именно это решение было выбрано.
И это правило работает в обе стороны: если невозможно описать зачем было сделано изменение или почему оно именно такое -- это скорее всего плохое изменение.

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

Оба в равной мере бесполезны, как и сам этот коммит, судя по всему.

Comments

[arzamas-nick]

А как Вы данное действие комитили бы?

[Victor Bomberow]

arzamas-nick, у себя, локально, вы можете делать насколько угодно частые коммиты, оставляя "зачем вы сделали изменения в коде", допустим, в названии ветки. Ваш локальный репозиторий не обязан быть точной копией origin. Когда вы закончите работу над частью реализации фичи, вы можете соединить коммиты (которые имеют смысл лишь для вас как точки сохранения вашего процесса изменения кода) в один, в котором явно опишите изменение (которое имеет смысл для другого разработчика) и его запушите, снабдив описанием, про которое вам ответили выше.

[arzamas-nick]

Vito Ombero, спасибо. Походу догнал. Получается я беру и клонирую репозиторий и создаю новую ветку для себя (локальный), где я пишу комиты только для себя, и когда я дорабатываю/выполню поставленную задачу мне уже нужно слить в master ветку и там в комитах уже писать то зачем я сделал этот комит и отправить git push origin master я правильно понял ? (в этом случае "git push origin master" пушит изменения только с ветки мастер, а с локальной ветки который я создавал после клонирования не попадут в удаленный хост ?)

[Victor Bomberow]

arzamas-nick, да, примерно так. Приведенный вами пример скорее всего является лишь одним из шагов реализации изменения части проекта, который вы делаете в рамках воплощения какой-то фичи. Такой коммит никому пользы не несёт, поэтому его лучше объединить с другими. У вас в локальном, атомарность изменений может быть мельче, чем это нужно на практике.

Answer 2

[Iloveski]

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

Comments

[arzamas-nick]

jira нет не использую. Вот вы тут пишите "зачем вы сделали изменения в коде" а я видео курсах слышал нужно писать "что делает данный комит" получается это плохое решение писать "что делает данный комит", нужно писать причину комита?

[Iloveski]

arzamas-nick, представь ситуацию, заходит человек в код через год и думает, а на фига это здесь? Посмотрел по истории и увидел зачем или же не увидел и выпилил. И все сломалось

[arzamas-nick]

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

[Iloveski]

arzamas-nick, в принципе, лучшая практика, делать так, как написал коллега из ответа выше

Answer 3

[Vitsliputsli]

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

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