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