Журнал изменений - Changelog
А журнал изменений это журнал или запись всех заметных изменений, внесенных в проект. Проект часто бывает интернет сайт или программный проект, и журнал изменений обычно включает записи об изменениях, таких как исправления ошибок, новые функции и т. д. Открытый исходный код проекты включают журнал изменений как один из файлов верхнего уровня в своем распространении.
Журнал изменений исторически включал все изменения, внесенные в проект. Сайт «Вести журнал изменений» вместо этого рекомендует, чтобы журнал изменений нет включают все изменений, но вместо этого он должен содержать «тщательно подобранный, упорядоченный в хронологическом порядке список заметных изменений для каждой версии проекта» и не должен быть «дампом» журнала git, «потому что это никому не помогает».[1]
Хотя каноническое соглашение об именах для файла Журнал изменений,[2] иногда его альтернативно называют ИЗМЕНЕНИЯ или же ИСТОРИЯ (НОВОСТИ обычно это другой файл, отражающий изменения между выпусками, а не между коммитами). Другое соглашение - называть это ИЗМЕНЕНИЕ.[1] Немного сопровождающие проекта добавит .текст суффикс к имени файла, если журнал изменений простой текст, а .md суффикс, если он в Markdown, или .rst суффикс, если он в reStructuredText.
Немного контроль версий системы могут генерировать релевантную информацию, которая подходит в качестве журнала изменений, если цель состоит в том, чтобы включить все изменения.
А golang История изменений является синонимом набор изменений кода и связанная проверка кода.
Формат
Файлы журнала изменений организованы по параграфам, которые определяют уникальное изменение в функции или файле. Стандарты кодирования GNU рекомендуют следующий формат:[3]
ГГГГ-ММ-ДД Джон Доу* myfile.ext (myfunction): мои изменения внесли дополнительные изменения * myfile.ext (unrelated_change): мои изменения внесены в myfile.ext, но полностью не связаны с приведенным выше * anotherfile .ext (somefunction): больше изменений
Обратите внимание, что между датой и именем, а также между именем и адресом электронной почты есть два пробела. Обычно адрес электронной почты заключают в <и>. В Редактор Emacs создает такие записи при создании дополнительных записей журнала изменений.
Журналы изменений в вики
Наиболее вики программное обеспечение включает журналы изменений как фундаментальная функция (часто называемая история в контексте). Например, ссылка «Просмотреть историю» вверху[4] из Википедия запись ссылается на журнал изменений этой страницы. Эта функция жизненно важна для соблюдения требований атрибуции некоторых лицензий на авторское право.[нужна цитата ]
Журналы изменений продукта
Журнал изменений продукта позволяет держать клиентов в курсе того, что нового. Это помогает сообщать о новых функциях, последних выпусках и актуальных новостях прямо в приложении.
Смотрите также
Примечания
- ^ а б "Вести журнал изменений". keepachangelog.com. Получено 2019-09-03.
- ^ Руководство GNU automake.
- ^ «Стандарты кодирования GNU: стиль журналов изменений». Gnu.org. Получено 2019-09-03.
- ^ Справка: Page_history.