Почему я должен использовать редактор для сообщений Git commit?
У меня такое ощущение, что почти все используют редактор (Vim, Notepad ++ и т. Д.) Для сообщений коммитов Git Почему?
Я нахожу, что набрать -m и пару кавычек легко и предоставляет легкий способ повторить фиксацию (нажатие стрелки вверх). Я полагаю, что проще делать многострочные сообщения фиксации в редакторе, но мне достаточно сложно убедить коллег написать любое сообщение !
5 ответов
Вы упомянули самое главное - длина. Сообщения о фиксации должны по существу всегда быть многострочными. Единственными исключениями являются тривиальные коммиты (например, «увеличенный номер версии до X.X.X») или слияние без конфликтов (хотя даже в этом случае добавление короткого журнала - неплохая идея). В среднем коммите, если такая вещь существует, вероятно, должно быть на пару предложений помимо темы; в некоторых даже могут быть абзацы. Просто посмотрите журнал git.git ; это почти гарантированно будет хорошим примером стиля и длины сообщения фиксации.
Я понимаю, что может быть трудно убедить других писать хорошие сообщения о коммитах, но это не значит, что вы не можете - и вам, вероятно, будет проще использовать редактор для их написания.
(У меня точно такой же опыт работы. Мои коллеги - в первую очередь инженеры, во вторую - программисты, а также пользователи системы контроля версий ... в третьих, были бы великодушны. Но вы, по крайней мере, можете выполнять свою работу правильно !)
Правильное сообщение фиксации git почти всегда должно быть многострочным.Из официального обсуждения git-commit ,
Хотя это и не обязательно, но это хорошая идея. чтобы начать сообщение фиксации с одиночный короткий (менее 50 знаков) строка, обобщающая изменение, за которой следует пустой строкой, а затем еще подробное описание. Инструменты, которые поворачивают фиксируется в электронной почте, например, используйте первая строка в строке Тема: а остальная часть фиксации в тело.
Если вам трудно получить какие-либо сообщения о фиксации (поговорите со своим системным администратором и / или), убедитесь, что хотя бы одна из переменной среды GIT_EDITOR, переменной конфигурации core.editor, переменной среды VISUAL или переменная среды EDITOR установлена на что-то полезное.
Можно создать собственный «редактор», который запрашивает короткое (<50 символов) описание, а затем минимальное количество символов или предложений. Возможно, это не будет хорошо принято, но это будет зависеть от вашего положения и культуры вашей рабочей среды.
У некоторых людей есть условные обозначения, , например следующее :
Краткое (50 символов или меньше) краткое изложение изменения
Более подробный пояснительный текст, если необходимый. Оберните примерно 72 персонажей или около того. В некоторых случаях первая строка рассматривается как тема электронного письма и остальная часть текст как тело. Пустая строка отделение резюме от тела имеет решающее значение (если вы не опустите тело полностью); инструменты, такие как rebase, могут получить сбит с толку, если вы запустите их вместе.
Напишите сообщение о коммите в настоящее время: «Исправить ошибку», а не «Исправлена ошибка». Это соглашение соответствует вверх с сообщениями фиксации, созданными такие команды, как git merge и git возвращаться.
Остальные абзацы идут после пустых. линий.
- Маркеры тоже подходят.
- Обычно для маркера используется дефис или звездочка, которым предшествует
одиночный пробел, с пустыми строками в между ними, но здесь соглашения различаются- Используйте выступ
Удачи вам в этом без использования редактора.
В редакторе вы можете писать более длинные сообщения, выполнять форматирование, такое как выравнивание по ширине до 80 столбцов и т. Д. Возможно, у вас есть шаблон для сообщений фиксации, который вы копируете и вставляете. Вы можете делать это в текстовых редакторах.
Сначала я начал изучать vim, установив его в качестве редактора по умолчанию для Mercurial; это заставило меня хотя бы знать основные команды, если я хотел что-то сделать. Теперь все время использую vim.