Changelog

<h2 id="format">Format</h2>
<p>Changelog files are organized by paragraphs, which define a unique change within a function or file.
The <a href="/facts/GNU_coding_standards/96bqMu5m">GNU Coding standards</a> recommend the following format:<a class="footnote-ref" id="fnref:7" href="#fn:7"><sup>7</sup></a>
</p>
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 made by me.

<p>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 <a href="/facts/Emacs/BvGxuAxQ">Emacs editor</a> creates such entries when creating additional changelog entries.
</p>
<h2 id="changelogs-in-wikis">Changelogs in wikis</h2>
<p>Most <a href="/facts/Wiki/uCKCEzqb">wiki</a> software includes <i>changelogs</i> as a fundamental feature (often called <i>history</i> in this context). For example, the "View history" link at the top<a class="footnote-ref" id="fnref:8" href="#fn:8"><sup>8</sup></a> of a <a href="/facts/Wikipedia/KDRNKWnc">Wikipedia</a> entry links to that page's changelog. This feature is vital for complying   with the attribution requirements of some copyright licenses.
</p>
<h2 id="product-changelogs">Product changelogs</h2>
<p>A product changelog can keep customers in the loop about what's new. It helps to announce new features, latest releases, and relevant news directly in-app.
</p>
<h2 id="see-also">See also</h2>

<ul><li><a href="/facts/Log_file/p7FHf8mA">Log file</a></li>
<li><a href="/facts/Change_control/c9bv6CPq">Change control</a></li>
<li><a href="/facts/Release_notes/KeEmUGXr">Release notes</a></li>
<li><a href="/facts/Web_feed/reBfT1GS">Web feed</a></li>
<li><a href="/facts/Diff/MtzRWwql">Diff</a></li>
<li><a href="/facts/Technology_roadmap/ov21IlGM">Technology roadmap</a></li></ul>
<h2 id="notes">Notes</h2>

<h2 id="external-links">External links</h2>
<ul><li><a href="https://www.gnu.org/prep/standards/standards.html#Change-Logs">GNU Coding Standards: Change Logs</a></li>
<li><a href="http://keepachangelog.com/">Keep a CHANGELOG</a></li>
<li><a href="https://co-pilot.dev/changelog">Checklist for creating a changelog</a></li></ul>

Look up <i>changelog</i> in Wiktionary, the free dictionary.

<h2 id="references">References</h2>

<ol>
<li id="fn:1"><p>Kuchenrither, Richard D.; Hite, Robert W.; Gerali, Catherine R.; Brennan, William F.; Wilson, David (1 January 2008). "New Innovations for Program Management … Challenges and Successes". Proceedings of the Water Environment Federation. 2008 (14): 2331–2344. doi:10.2175/193864708788734656. <a href="/wiki/Doi_(identifier)" target="_blank">/wiki/Doi_(identifier)</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li>
<li id="fn:2"><p>Lewko, Caroline (2021). Developer Relations: How to Build and Grow a Successful Developer Program. Berkeley, CA: Apress L. P. pp. 189–194. ISBN 978-1484271636. <a href="978-1484271636" target="_blank">978-1484271636</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li>
<li id="fn:3"><p>"Keep a Changelog". keepachangelog.com. <a href="https://keepachangelog.com/en/1.0.0/" target="_blank">https://keepachangelog.com/en/1.0.0/</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li>
<li id="fn:4"><p>The GNU automake manual. <a href="https://www.gnu.org/software/automake/manual/html_node/Gnits.html#Gnits" target="_blank">https://www.gnu.org/software/automake/manual/html_node/Gnits.html#Gnits</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li>
<li id="fn:5"><p>"Keep a Changelog". keepachangelog.com. <a href="https://keepachangelog.com/en/1.0.0/" target="_blank">https://keepachangelog.com/en/1.0.0/</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li>
<li id="fn:6"><p>Atlassian. "What is version control | Atlassian Git Tutorial". Atlassian. Retrieved 2022-02-17. <a href="https://www.atlassian.com/git/tutorials/what-is-version-control" target="_blank">https://www.atlassian.com/git/tutorials/what-is-version-control</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li>
<li id="fn:7"><p>"GNU Coding Standards: Style of Change Logs". Gnu.org. Retrieved 2019-09-03. <a href="https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html" target="_blank">https://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></p></li>
<li id="fn:8"><p>Help:Page_history. <a href="/wiki/Help:Page_history" target="_blank">/wiki/Help:Page_history</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></p></li>
</ol>

Changelog open-in-new

Changelog