Журнал изменений (также называемый журналом изменений [1] ) — это журнал или запись всех заметных изменений, внесенных в проект. Проект часто представляет собой веб-сайт или проект программного обеспечения, и журнал изменений обычно включает записи об изменениях, таких как исправления ошибок, новые функции и т. д. Некоторые проекты с открытым исходным кодом включают журнал изменений в качестве одного из файлов верхнего уровня в своем дистрибутиве.
Журнал изменений исторически включал все изменения, внесенные в проект. Вместо этого сайт «Сохраните список изменений» выступает за то, чтобы журнал изменений не включал все изменения, а вместо этого содержал «кураторский, хронологически упорядоченный список значимых изменений для каждой версии проекта» и не должен быть «свалкой» git log, «потому что это никому не поможет». [2]
Хотя каноническое соглашение об именовании файла в GNU ( Automake ) — ChangeLog , [3] иногда его альтернативно называют CHANGES или HISTORY ( NEWS обычно представляет собой другой файл, отражающий изменения между выпусками, а не между коммитами). Другое соглашение — называть его CHANGELOG . [2] Некоторые сопровождающие проекта добавляют суффикс .txt к имени файла, если журнал изменений представляет собой обычный текст , суффикс .md, если он находится в Markdown , или суффикс .rst , если он находится в reStructuredText .
Некоторые системы контроля версий способны генерировать соответствующую информацию для журнала изменений, если цель состоит в том, чтобы включить все изменения. [4]
Файлы журнала изменений организованы по абзацам, которые определяют уникальные изменения внутри функции или файла. Стандарты кодирования GNU рекомендуют следующий формат: [5]
ГГГГ-ММ-ДД␣␣Джон Доу␣␣<[email protected]> * myfile.ext (myfunction): мои изменения. дополнительные изменения * myfile.ext (unrelated_change): мои изменения. в myfile.ext, но совершенно не связан с вышеизложенным * Anotherfile.ext (somefunction): дополнительные изменения, внесенные мной.
Обратите внимание, что между датой и именем, а также между именем и адресом электронной почты есть по два пробела. Обычно адрес электронной почты заключают в < и >. Редактор Emacs создает такие записи при создании дополнительных записей журнала изменений.
Большинство вики -программ включают журналы изменений в качестве фундаментальной функции (в этом контексте часто называемой историей ). Например, ссылка «Просмотреть историю» вверху [6] записи Википедии ведет на журнал изменений этой страницы. Эта функция жизненно важна для соблюдения требований об атрибуции некоторых лицензий на авторские права. [ нужна цитата ]
Журнал изменений продукта может держать клиентов в курсе того, что нового. Это помогает анонсировать новые функции, последние выпуски и актуальные новости прямо в приложении. [ нужна цитата ]
