Каково использование сообщений о фиксации?
Я боролся, задавая тот вопрос, но здесь это. Я использую управление исходным кодом с нескольких лет для нескольких проектов с помощью различных систем (svn, hg, мерзавец), и я изучил, как улучшить мои сообщения следующими инструкциями и т.д. Но насколько я могу помнить, что никогда не взглянул на них впоследствии.
Так..., как Вы получаете прибыль из своих собственных сообщений о фиксации? Когда я должен возвратиться, потому что я разбил что-то, и нуждаются в начале с нуля, я обычно просто возвращаюсь к последнему "узлу" (где я запустил или объединил ответвление). Я пишу те сообщения только для людей, контролирующих проект, кому любопытно, что продолжается?
С уважением
6 ответов
«Пришлите мне список того, что вы сделали за последние две недели» - Босс
Какой смысл в коммите без примечания, в котором говорится, что это такое? Это всё равно, что спросить: "Почему у книг есть заголовки по бокам?", или, возможно, "Почему у книг есть индексы и номера страниц?". Мне кажется, что журнал контроля исходных текстов, не содержащий описания каждого изменения, будет не очень полезен.
Причины, по которым вам может понадобиться обратиться к сообщению о фиксации, включают
- Появилась ошибка, и вы хотите узнать, когда эта часть кода была изменена в последний раз
- Вы решили отменить некоторые изменения и должны решить, к какой ревизии вернуться
В любом из этих случаев без хороших сообщений о фиксации вам пришлось бы просматривать диффы для каждой фиксации, пока вы не нашли бы в коде то, что искали.
Вы пишете их в помощь себе в будущем и другим членам команды. Чтобы дать вам некоторую предысторию того, когда я нашел их полезными:
Я работал над проектом, в котором сообщения коммитов были неоценимы - не раз я использовал их для отслеживания кода, которому уже много лет. В этом проекте наша система отслеживания ошибок также была интегрирована с нашей VCS (ClearCase). Поэтому, когда вы отметили изменение, оно запишет номер ошибки в комментариях к фиксации. Это было очень полезно, чтобы вы могли точно отследить, что было изменено и почему.
Подводя итог, хотя сообщения о фиксации могут показаться бессмысленными, если вы только начинаете (особенно если вы единственный, кто работает над проектом), они становятся бесценными, когда у вас есть успешный продукт, поддерживаемый в производстве несколько разработчиков.
Обновление
Еще одна полезная функция сообщений фиксации заключается в том, что они требуют от вас просмотра и обобщения только что внесенных вами изменений. Даже если я помню, что я изменил, я часто делаю быстрое сравнение файла, прежде чем возвращать его. Я кратко перечитываю его снова, чтобы убедиться, что нет опечаток, что я изменил все, что хотел, и т. Д. Это простой способ проверить ваш код на предмет тех мелких ошибок, которые иначе могли бы проникнуть в ваш код. В любом случае, после этого у меня есть четкое представление о том, что изменилось, поэтому я использую это, чтобы написать краткое изложение изменений при проверке файла. Это простая привычка, которая помогает повысить качество кода без особых усилий с вашей стороны.
Ваши сообщения предназначены скорее для других пользователей, чем для вас. Хотя я стараюсь размещать хорошие сообщения о фиксации даже в личных репозиториях. Это помогает, когда вы отвлеклись от проекта и заходите в него спустя несколько месяцев, чтобы узнать, что недавно было сделано по проекту.
В лучшем случае, коммит привязывается к рабочему элементу в feature/bug tracker. Таким образом, вы сможете легко увидеть, какая функция/баг была реализована/исправлена. Это полезно не только для того, чтобы знать, содержит ли определённая ревизия функцию или исправление ошибки, но и для того, чтобы легко создать примечание к релизу.
Я обнаружил, что сообщения о фиксации - это хороший способ удержать себя от недостаточно частых фиксаций. Если я не могу изложить изменения в коротком сообщении о фиксации, то, вероятно, мне следовало бы зафиксировать изменения раньше.