Changelog: Difference between revisions
Jump to navigation
Jump to search
| Line 12: | Line 12: | ||
=Guiding Principles= | =Guiding Principles= | ||
* There should be an entry for every single version. | * There should be an entry for every single version. | ||
* The same type fo changes: | * The same type fo changes should be grouped together: | ||
** "Added" new features | ** "Added" new features | ||
** "Changed" to existing functionality | ** "Changed" to existing functionality | ||
| Line 19: | Line 19: | ||
** "Fixed" bug fixes | ** "Fixed" bug fixes | ||
** "Security" in case of vulnerabilities) | ** "Security" in case of vulnerabilities) | ||
* Versions and sections should be linkable. | * Versions and sections should be linkable. | ||
* The latest version comes first. | * The latest version comes first. | ||
Revision as of 02:17, 11 April 2021
External
- https://keepachangelog.com/en/1.0.0/
- https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md
Internal
Overview
A CHANGELOG is a text file that contains a curated, synthetic and chronologically ordered list of notable changes for each version of the project. This is useful because it is easier to describe notable changes in this format instead of asking the users to parse Git logs. In the words of https://keepachangelog.com/, "Who needs a changelog? 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."
Guiding Principles
- There should be an entry for every single version.
- The same type fo changes should be grouped together:
- "Added" new features
- "Changed" to existing functionality
- "Deprecated" soon-to-be-removed features
- "Removed" previously deprecated features
- "Fixed" bug fixes
- "Security" in case of vulnerabilities)
- Versions and sections should be linkable.
- The latest version comes first.
- The release date of each version is displayed.