|This article relies largely or entirely upon a single source. (September 2010)|
A changelog is a log or record of changes made to a project, such as a website or software project, usually including such records as bug fixes, new features, etc. Some 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, 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 maintainers 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.
YYYY-MM-DD John Doe <firstname.lastname@example.org> * 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
Note that between the date and the name, and again between the name and the email address, there are two spaces each. It is common to enclose the email address in < and >. The Emacs Editor creates such entries when creating additional changelog entries.
Changelogs in Wikis
Most Wiki software includes changelogs as a fundamental feature (often called history in this context). For example, the "View 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 some copyright licenses.
- 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.
|This programming tool–related article is a stub. You can help Wikipedia by expanding it.|
|This free software–related article is a stub. You can help Wikipedia by expanding it.|