Журнализация изменений проекта — Википедия
Журнализа́ция измене́ний прое́кта (англ. changelog) представляет собой программное протоколирование изменений, вносимых в большой проект. Таким проектом может быть веб-сайт или проект программного обеспечения. Обычно записи журнала изменений содержат информацию об исправлении ошибок, о новых возможностях и т.д. Большинство проектов с открытым кодом содержат журнал изменений, как один из файлов верхнего уровня.
Каноническим именем для файлов изменений является ChangeLog,[1] но иногда его называют CHANGES или HISTORY (NEWS обычно называют файлы, отражающие изменения версий, а не протоколирование изменений). Некоторые программы сопровождения проектов добавляют к имени файла суффикс .txt.
Некоторые системы управления версиями способны генерировать соответствующую информацию, которая подходит для журнализации изменений.
Формат
[править | править код]Файлы изменений организованы в соответствии с пунктами, которые определяют уникальные изменения в функции или файле. Большинство файлов изменений имеют следующий формат:[2]
YYYY-MM-DD John Doe <[email protected]> * myfile.ext (myfunction): my changes made additional changes * myfile.ext (unrelated_change): my changes made to myfile.ext but completely unrelated to the above * anotherfile.ext (somefunction): more changes
Обратите внимание, что между датой и именем и затем между именем и адресом электронной почты есть пробелы. Правилом являются также заключений адреса электронной почты в кавычки < и >. Такие дополнительные записи в журнал изменений добавляет редактор Emacs.
Журнализация изменений в Википедии
[править | править код]Большинство программного обеспечения проекта Wiki включает журнал изменений как основополагающую характеристику (часто он в этом контексте называется историей). Так, например, ссылка «История» в верхней части окна Википедии позволяет перейти на страницу журнала изменений данной статьи. Эта функция жизненно важна для соблюдения требований атрибуции некоторых авторских лицензий.
См. также
[править | править код]Примечания
[править | править код]- ↑ The GNU automake manual . Дата обращения: 27 декабря 2011. Архивировано 27 декабря 2011 года.
- ↑ GNU Coding Standards: Style of Change Logs . Дата обращения: 27 декабря 2011. Архивировано 26 декабря 2011 года.
Ссылки
[править | править код]- Explanations, how to write Changelog entries in open source projects
- The Changelog, a podcast and blog that covers what's fresh and new in Open Source (essentially covering "the changelog" of open source projects)
- PAD, one of the many changelog techs.
- keep a changelog, проект о важности и методике ведения журнала изменений.