Changelog →

Several tools are available to help maintain a changelog, including:

A CHANGELOG is more than a text file. It is a contract between the maker and the user. It is a marketing asset, a customer support tool, and a historical record all rolled into one. CHANGELOG

: New contributors can quickly get up to speed by reviewing the historical evolution of the codebase. Several tools are available to help maintain a

Without a CHANGELOG, users feel like they are living in a house where someone moves the furniture every night while they sleep. With a CHANGELOG, they have a map. : New contributors can quickly get up to

: Group updates into specific, linkable sections such as: Added : For new features. Changed : For changes in existing functionality. Deprecated : For soon-to-be-removed features. Removed : For features that have been taken out. Fixed : For bug fixes. Security : In case of vulnerabilities. Chronological Order : List the most recent version first.