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

редактировать
Журнал или запись всего заметные изменения, внесенные в проект

A журнал изменений - это журнал или запись всех заметных изменений, внесенных в проект. Проект часто представляет собой веб-сайт или программный проект, и журнал изменений обычно включает записи об изменениях, таких как исправления ошибок, новые функции и т. Д. Некоторые проекты с открытым исходным кодом включают журнал изменений как один файлов верхнего уровня в их раздаче.

Исторически журнал изменений включал все изменения, внесенные в проект. Сайт «Вести журнал изменений» вместо этого рекомендует, чтобы журнал изменений не включал все изменения, а вместо этого должен содержать «тщательно подобранный, упорядоченный в хронологическом порядке список заметных изменений для каждой версии проекта» и не должен быть «свалкой» git log «потому что это никому не помогает».

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

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

A Журнал изменений golang является синонимом набора изменений кода и соответствующей проверки кода.

Содержание

  • 1 Формат
  • 2 Журналы изменений в вики
  • 3 Журналы изменений продукта
  • 4 См. Также
  • 5 Примечания
  • 6 Внешние ссылки

Формат

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

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

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

Журналы изменений в вики

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

Журналы изменений продукта

Журнал изменений продукта позволяет держать клиентов в курсе того, что нового. Это помогает сообщать о новых функциях, последних выпусках и актуальных новостях прямо в приложении.

См. Также

Примечания

Внешние ссылки

Последняя правка сделана 2021-05-14 05:30:12
Содержание доступно по лицензии CC BY-SA 3.0 (если не указано иное).
Обратная связь: support@alphapedia.ru
Соглашение
О проекте