Войти
A журнал изменений - это журнал или запись всех заметных изменений, внесенных в проект. Проект часто представляет собой веб-сайт или программный проект, и журнал изменений обычно включает записи об изменениях, таких как исправления ошибок, новые функции и т. Д. Некоторые проекты с открытым исходным кодом включают журнал изменений как один файлов верхнего уровня в их раздаче.
Исторически журнал изменений включал все изменения, внесенные в проект. Сайт «Вести журнал изменений» вместо этого рекомендует, чтобы журнал изменений не включал все изменения, а вместо этого должен содержать «тщательно подобранный, упорядоченный в хронологическом порядке список заметных изменений для каждой версии проекта» и не должен быть «свалкой» git log «потому что это никому не помогает».
Хотя каноническое соглашение об именах для файла - ChangeLog, иногда его альтернативно называют CHANGES или HISTORY (NEWS - это обычно другой файл, отражающий изменения между выпусками, а не между совершает). Другое соглашение - называть его CHANGELOG. Некоторые специалисты по сопровождению проекта будут добавлять суффикс.txt к имени файла, если журнал изменений представляет собой обычный текст, суффикс.md, если он находится в Markdown, или суффикс.rst, если он находится в reStructuredText.
Некоторые системы контроля версий могут генерировать соответствующую информацию, которая подходит в качестве журнала изменений, если цель состоит в том, чтобы включить все изменения.
A Журнал изменений golang является синонимом набора изменений кода и соответствующей проверки кода.
Файлы журнала изменений организованы по абзацам, которые определяют уникальное изменение внутри функции или файла. Стандарты кодирования GNU рекомендуют следующий формат:
