Рекомендации по написанию сообщения об изменениях в системах контроля версий?

Question

Существуют ли какие-либо практические правила или рекомендации по написанию changes message систем контроля версий?

Очевидный ответ может показаться a brief description of the most important changes, но в действительности не всегда легко выбрать наиболееважные изменения и кратко опишите соответствующие аспекты этих изменений, особенно на ранних стадиях разработки, когда добавляются большие куски кода.

Answer 1

Это зависит от целей проекта.Мы используем Git и требуем четыре поля:

Краткое резюме (одна строка - тема коммита)

Связанные билеты (используется для интеграции с Trac)

Подробный отчет

Требуется дальнейшая работа

В наших репозиториях Git есть хуки, которые требуют правильного заполнения формы сообщения о коммите, в противном случае сервер отклоняет коммиты.

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

Answer 2

Я считаю полезным начинать фиксацию сообщений с глаголов прошедшего времени: Рефакторинг класса X , Добавлена ​​функция Y , Откат предыдущего изменения и т. Д.Этот непротиворечивый стиль облегчает чтение журналов сообщений, когда вы приходите к ним позже, чтобы просмотреть их.

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

Answer 3

Не всегда легко выбрать наиболее важные изменения и описать соответствующие аспекты этих изменений

Может быть, если вы сохраняете свои коммиты плотно и сосредотачиваетесь на конкретном изменении, как в «логически отдельном наборе изменений»: см. « частота коммитов git ».
(И не забудьте правильно обернуть ваши комментарии : в зависимости от других инструментов обработки (электронных писем, инструментов исправлений) длина строки комментария может иметь значение.