-
This CHANGELOG file
-
Basic guidelines, including proper date formatting.
Added
for new features.Changed
for changes in existing functionality.Deprecated
for soon-to-be removed features.Removed
for now removed features.Fixed
for any bug fixes.Security
in case of vulnerabilities.
Date should be written in Year-Month-Day format, for example:
2020-03-14
Versions should be formatted
X.Y.Z
(major.minor.patch)
Features in progress can be added to the Unreleased
section on top,
then moved down into a log entry when they're released.
The format is based on Keep a Changelog