Журнал изменений

Журнал изменений (также пишется как change log ^[1] ) — это журнал или запись всех существенных изменений, внесенных в проект. Проект часто представляет собой веб-сайт или программный проект, а журнал изменений обычно включает записи изменений, таких как исправления ошибок, новые функции и т. д. Некоторые проекты с открытым исходным кодом включают журнал изменений в качестве одного из файлов верхнего уровня в своем дистрибутиве.

Журнал изменений исторически включал все изменения, внесенные в проект. Сайт «Keep a Changelog» вместо этого выступает за то, чтобы журнал изменений не включал все изменения, а вместо этого содержал «курируемый, хронологически упорядоченный список значимых изменений для каждой версии проекта» и не был «свалкой» журнала git, «потому что это никому не помогает». ^[2]

Хотя каноническое соглашение об именовании GNU ( Automake ) для файла — ChangeLog , ^[3] иногда его также называют CHANGES или HISTORY ( NEWS — это обычно другой файл, отражающий изменения между выпусками, а не между коммитами). Другое соглашение — называть его CHANGELOG . [ ^2] Некоторые сопровождающие проекта добавляют суффикс .txt к имени файла, если журнал изменений — это простой текст , суффикс .md , если он в Markdown , или суффикс .rst , если он в reStructuredText .

Некоторые системы контроля версий способны генерировать соответствующую информацию для журнала изменений, если целью является включение всех изменений. ^[4]

Файлы журнала изменений организованы по параграфам, которые определяют уникальное изменение в пределах функции или файла. Стандарты кодирования GNU рекомендуют следующий формат: ^[5]

ГГГГ-ММ-ДД␣␣Джон Доу␣␣<johndoe@example.com> * myfile.ext (myfunction): внесенные мной изменения дополнительные изменения. * myfile.ext (unrelated_change): внесенные мной изменения в myfile.ext, но совершенно не связанный с вышеизложенным. * anotherfile.ext (somefunction): дополнительные изменения, внесенные мной.

Между датой и именем, а также между именем и адресом электронной почты, есть по два пробела. Обычно адрес электронной почты заключают в < и >. Редактор Emacs создает такие записи при создании дополнительных записей журнала изменений.

Большинство программного обеспечения вики включают журналы изменений как фундаментальную функцию (часто называемую историей в этом контексте). Например, ссылка «Просмотреть историю» в верхней части ^[6] записи в Википедии ведет к журналу изменений этой страницы. Эта функция жизненно важна для соответствия требованиям атрибуции некоторых лицензий на авторские права. ^{[ необходима цитата ]}

Журнал изменений продукта может держать клиентов в курсе того, что нового. Он помогает анонсировать новые функции, последние релизы и соответствующие новости непосредственно в приложении. ^{[ необходима цитата ]}

• Стандарты кодирования GNU: журналы изменений
• Ведите журнал изменений
• Контрольный список для создания журнала изменений

Найдите журнал изменений в Викисловаре, бесплатном словаре.