[CHANGELOG]

View original Gist on GitHub

Tags: #changelog

CHANGELOG.md

https://keepachangelog.com/

Guiding Principles

Changelogs are for humans, not machines.
There should be an entry for every single version.
The same types of changes should be grouped.
Versions and sections should be linkable.
The latest version comes first.
The release date of each version is displayed.
Mention whether you follow Semantic Versioning.

Types of changes

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.

Example

# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [[2.0.0] - 2019-11-19](https://github.com/foo/bar/pull/4)
### Added
- New breaking API.

## [[1.1.1] - 2019-03-21](https://github.com/foo/bar/pull/3)
### Fixed
- Hotfix for bug.

## [[1.1.0] - 2016-08-01](https://github.com/foo/bar/pull/2)
### Added
- New non-breaking feature.

## [[1.0.0] - 2015-04-29](https://github.com/foo/bar/pull/1)
### Added
- Initial thing.