Skip to main content

Changelog

FACT: "When the software changes, people want to know why and how."

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. We must keep a changelog to make it easier for users to see precisely what changes have been made between each release/version of the project.

The changelog should:

  • Have one section per release/version.
  • List releases in reverse-chronological order (newest on top).
  • Write all dates in YYYY-MM-DD format.

Each version should:

  • List its release date in the above format.
  • Group changes to describe their impact on the 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. Known Issues to inform users about well known issues/bugs that are going to be fixed in a future release.

Example:

[1.5.190.20210319] - 2021-03-19

Added
- Alarm badges to dashboard.
- New report for door alarms.
- Door open/close alarms for an extended period.

Changed
- The temperature graph is now showing upper and lower temp limits.

Removed
- The Loaded/Unloaded alarm indicators from dashboard.