Changelog
418017
221822361
2008-06-26T07:15:53Z
Mimihitam
4383153
A '''changelog''' is a log or record of changes made to a project, such as a [[website]] or software project. Most [[open source]] projects include a changelog as one of the top level files in their distribution.
Although the canonical naming convention for the file is ''ChangeLog'',<ref>[http://www.gnu.org/software/automake/manual/html_node/Gnits.html#Gnits The GNU automake manual]</ref> it is sometimes alternatively named as ''CHANGES'' or ''HISTORY'' (''NEWS'' is usually a different file reflecting changes between releases, not between the commits). Some [[project maintainer]]s will append a ''.txt'' suffix to the file name.
Some [[revision control]] systems are able to generate the relevant information that is suited as a changelog.
==Format==
Changelog files are organized by paragraphs, which define a unique change within a function or file.
Most changelog files follow the following format:
<pre>
YYYY-MM-DD John Doe johndoe@example.com
* myfile.ext (myfunction): my changes made
additional changes
* anotherfile.ext (somefunction): more changes
</pre>
==Changelogs in Wikis==
Most [[Wiki]] software includes ''changelogs'' as a fundamental feature (often called ''history'' in this context). For example, the "history" link at the top of a [[Wikipedia]] entry links to that page's changelog. This feature is vital for complying with the attribution requirements of the [[GNU Free Documentation License]] that Wikipedia contributors license their text under.
==Notes==
{{reflist}}
==External links==
* [http://www.gnu.org/software/guile/changelogs/guile-changelogs_3.html Explanations, how to write Changelog entries in open source projects]
[[Category:Files]]
[[Category:Free software culture and documents]]
[[Category:Technical communication]]
{{software-stub}}
{{free-software-stub}}
[[de:Changelog]]
[[es:Registro de cambios]]
[[fr:ChangeLog]]
[[id:Changelog]]
[[it:ChangeLog]]
[[lt:Keitimų žurnalas]]
[[nl:Changelog]]
[[ko:Changelog]]