Ведение файла changelog.txt в DVCS - PullRequest
Новая
       4

Ведение файла changelog.txt в DVCS

8 голосов
/ 01 марта 2011

Я работаю над git-проектом, который использует множество веток. По большей части это был действительно отличный рабочий процесс. Я счастлив объединяться между ветвями, люблю возможность выбирать код и весь жизненный цикл, который идет с git и другими dvcs.

У меня есть одна болевая точка, которая действительно причиняет боль. Как сохранить файл changelog.txt.

Я обнаружил, что больно всякий раз, когда я делаю слияние (часто changelog.txt конфликтует), и когда коммиты по сбору вишен, мне случайно удалось получить изменения, которые действительно не были желательны.

Я бы хотел увидеть хороший ответ на эту проблему.

1 Ответ

6 голосов
/ 01 марта 2011

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

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

WHAT WHERE DESCRIPTION

Где WHAT может быть

  • FIX для исправления ошибок
  • CHG для изменений
  • NEW для нового кода

WHERE должно быть одним словом, описывающим модуль, в котором было выполнено WHAT.После этих двух сведений вы предоставляете DESCRIPTION, в котором подробно описывается изменение.

Когда вы будете готовы к отправке, получите журналы с последней версии и проанализируйте их.Журналы могут быть получены с помощью git log tagname_of_last_version...См. Справочную страницу git log для получения информации о параметрах вывода и фильтрации.

...