Skip to content
A formal specification for changelog files and entries
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Examples
CHANGELOG.md
LICENSE
README.md
Specification.md

README.md

Changelog

A formal specification for semantic changelog files and entries.

Quick Links

Rationale and Goals

The primary goal around the changelog specification is to formalise a structure for changelog files to bring consistency across projects.

A formal specification around changelogs may also allow automation via tools. Tools can understand semantics around changes, whether a change is breaking, an enhancement or a bug fix and automatically determine the next appropriate semantic version number. Along with dealing with any manual tasks around changelog management.

Examples

A small example changelog entry:

## 0.2.0

### Enhancements

* Adds support for versions of Swift included in Xcode.
* Added `swiftenv --help`.

Or rendered as markdown:

0.2.0

Enhancements

  • Adds support for versions of Swift included in Xcode.
  • Added swiftenv --help.

Examples Elsewhere

You can find examples of changelogs in the wild in the following projects:

Parsers & Generators

Interested in programmatically reading or manipulating your changelog?

You can’t perform that action at this time.