Changelog

A changelog is a log or record of all notable changes made to a project. The project is often a website or software project, and the changelog usually includes records of changes such as bug fixes, new features, etc. Some open-source projects include a changelog as one of the top-level files in their distribution.

A changelog has historically included all changes made to a project. The "Keep a Changelog" site instead advocates that a changelog not include all changes, but that it should instead contain "a curated, chronologically ordered list of notable changes for each version of a project" and should not be a "dump" of a git log "because this helps nobody".[1]

Although the canonical naming convention for the file is ChangeLog,[2] it is sometimes alternatively named as CHANGES or HISTORY (NEWS is usually a different file reflecting changes between releases, not between the commits). Another convention is to call it a CHANGELOG.[1] Some project maintainers will append a .txt suffix to the file name if the changelog is plain text, a .md suffix if it is in Markdown, or a .rst suffix if it is in reStructuredText.

Some revision control systems are able to generate the relevant information that is suited as a changelog if the goal is to include all changes.

A golang Change Log is synonymous with a set of code changes and the associated code review.

Format

Changelog files are organized by paragraphs, which define a unique change within a function or file. The GNU Coding standards recommend the following format:[3]

YYYY-MM-DD  John Doe  <johndoe@example.com>

    * 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[4] of a Wikipedia entry links to that page's changelog. This feature is vital for complying with the attribution requirements of some copyright licenses.

Product changelogs

A product changelog allows keeping customers in the loop about what's new. It helps to announce new features, latest releases, and relevant news directly in-app.

See also

Notes
  1. "Keep a Changelog". keepachangelog.com. Retrieved 2019-09-03.
  2. The GNU automake manual.
  3. "GNU Coding Standards: Style of Change Logs". Gnu.org. Retrieved 2019-09-03.
  4. Help:Page_history.
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.