A change log is a file which contains a curated, chronologically ordered list of notable changes for each version of a project or system. Change logs usually include records of changes such as system edits, data field changes, new features, etc.
Why keep a change log?To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
Who needs a change log?People do. Whether consumers or developers, the end users of software are human beings who care about what's in the software. When the software changes, people want to know why and how.
A good change log sticks to these principles:It’s made for humans, not machines, so legibility is crucial.Easy to link to any section.Each version should:List its change date.Group changes to describe their impact on the system or project, as follows:Added for new features.Changed for changes in existing functionality.Deprecated for once-stable features removed in upcoming releases.Removed for deprecated features removed in this release.Fixed for any bug fixes.Security to invite users to upgrade in case of vulnerabilities.