Почему я должен использовать редактор сообщений коммита Git?

Question

У меня такое ощущение, что почти все используют редактор (Vim, Notepad ++ и т. Д.) Для сообщений Git commit. Почему?

Я нахожу, что набрать -m и пару кавычек легко и предоставляет легкий способ повторить фиксацию (нажатие стрелки вверх). Я полагаю, что в редакторе проще делать многострочные сообщения о коммитах, но мне довольно сложно убедить коллег написать любое сообщение!

Answer 1

Вы упомянули самое важное - длину.Сообщения фиксации должны, по существу, всегда быть многострочными.Единственными исключениями являются тривиальные коммиты (например, «номер версии с повышенными значениями в XXX») или слияние без конфликтов (хотя даже тогда добавление шортлога не является плохой идеей).Средний коммит, если такая вещь существует, вероятно, должен иметь одно или два предложения вне предмета;некоторые могут даже иметь абзацы.Просто посмотрите на журнал git.git ;гарантированно это будет хорошим примером стиля и длины сообщения коммита.

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

(У меня точно такой же опыт работы на рабочем месте. Мои коллеги - инженеры, программисты и пользователи систем контроля версий ... третьищедрый. Но вы можете, по крайней мере, сделать свою работу правильно!)

Answer 2

Правильное сообщение git commit почти всегда должно быть многострочным. Из официального обсуждения git-commit ,

Хотя это и не обязательно, это хорошая идея начать сообщение с коммитом один короткий (менее 50 символов) строка, суммирующая изменение, сопровождаемая пустой строкой, а затем более подробное описание Инструменты, которые поворачивают фиксирует в электронной почте, например, использовать первая строка в теме: строка а остальная часть коммита в корпус.

Если вам трудно получать какие-либо сообщения о фиксации (поговорите со своим системным администратором и / или), убедитесь, что хотя бы одна из переменных среды GIT_EDITOR, переменная конфигурации core.editor, переменная среды VISUAL или переменная окружения EDITOR установлена ​​на что-то полезное.

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

Answer 3

У некоторых людей есть условные обозначения, , такие как следующие :

Краткая (50 символов или менее) сводка изменений

Более подробный пояснительный текст, еслинеобходимо.Оберните его примерно до 72 символов или около того.В некоторых контекстах первая строка рассматривается как тема письма, а остальная часть текста - как тело.Пустая строка, отделяющая сводку от тела, имеет решающее значение (если только вы не опускаете тело полностью);такие инструменты, как rebase, могут запутаться, если вы запустите их вместе.

Напишите ваше сообщение о коммите в настоящем времени: «Исправить ошибку», а не «Исправлена ​​ошибка».Это соглашение совпадает с сообщениями коммита, сгенерированными такими командами, как git merge и git revert.

Дальнейшие абзацы идут после пустых строк.

- С маркерами тоже все в порядке

Обычно для маркера используется дефис или звездочка, перед которым стоит один пробел
с пробелами между ними, но здесь используются разные условные обозначения

- используйте висячий отступ

Удачи в этом без использования редактора.

Answer 4

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

Answer 5

Сначала я начал изучать vim, установив его в качестве редактора по умолчанию для Mercurial;это заставило меня хотя бы знать основные команды, если я хотел что-то сделать.Теперь я все время пользуюсь vim.