Изменения представляют собой журнал или запись всех заметных изменений , внесенных в проект. Проект часто представляет собой веб-сайт или программный проект, и журнал изменений обычно включает записи об изменениях, таких как исправления ошибок, новые функции и т. Д. Некоторые проекты с открытым исходным кодом включают журнал изменений как один из файлов верхнего уровня в своем распространении.
Журнал изменений исторически включал все изменения, внесенные в проект. Сайт «Вести журнал изменений» вместо этого выступает за то, чтобы журнал изменений не включал все изменения, а вместо этого должен содержать «тщательно подобранный, упорядоченный в хронологическом порядке список заметных изменений для каждой версии проекта» и не должен быть «свалкой» git log «потому что это никому не помогает». [1]
Хотя канонический именования для файла ChangeLog , [2] иногда называют также ИЗМЕНЕНИЙ или ИСТОРИИ ( NEWS , как правило, другой файл , отражающий изменения между версиями, а не между фиксаций). Другое соглашение - называть его CHANGELOG . [1] Некоторые сопровождающие проекта добавляют суффикс .txt к имени файла, если журнал изменений представляет собой обычный текст , суффикс .md, если он находится в Markdown , или суффикс .rst, если он находится в reStructuredText .
Некоторые системы контроля версий могут генерировать релевантную информацию, которая подходит в качестве журнала изменений, если цель состоит в том, чтобы включить все изменения.
Golang Журнал изменений является синонимом набора изменений коды и связанным код обзором .
Формат
Файлы журнала изменений организованы по абзацам, которые определяют уникальное изменение в функции или файле. Стандарты кодирования GNU рекомендуют следующий формат: [3]
ГГГГ-ММ-ДД Джон Доу@example.com> * myfile.ext (myfunction): внесенные мной изменения дополнительные изменения * myfile.ext (unrelated_change): внесенные мной изменения в myfile.ext, но совершенно не связанный с приведенным выше * anotherfile.ext (somefunction): больше изменений
Обратите внимание, что между датой и именем, а также между именем и адресом электронной почты есть два пробела. Обычно адрес электронной почты заключают в <и>. 9,0 создает такие записи при создании дополнительных записей журнала изменений.
Журналы изменений в вики
Большинство вики- программ включает журналы изменений в качестве фундаментальной функции (часто называемой историей в этом контексте). Например, «Просмотр истории» ссылка в верхней части [4] в течение Википедии въездных ссылки на журнал изменений этой страницы. Эта функция жизненно важна для соблюдения требований атрибуции некоторых лицензий на авторское право. [ необходима цитата ]
Журналы изменений продукта
Журнал изменений продукта позволяет держать клиентов в курсе того, что нового. Это помогает сообщать о новых функциях, последних выпусках и актуальных новостях прямо в приложении.
Смотрите также
Заметки
- ^ a b «Вести журнал изменений» . keepachangelog.com . Проверено 3 сентября 2019 .
- ^ Руководство GNU automake .
- ^ «Стандарты кодирования GNU: стиль журналов изменений» . Gnu.org . Проверено 3 сентября 2019 .
- ^ Справка: История_страницы .