Skip to content

Instantly share code, notes, and snippets.

@arukavina
Created April 14, 2018 18:55
Show Gist options
  • Save arukavina/5da5142ba2ac1684e8b51d24f4e532cc to your computer and use it in GitHub Desktop.
Save arukavina/5da5142ba2ac1684e8b51d24f4e532cc to your computer and use it in GitHub Desktop.
CHANGELOG.md example

Changelog

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

[Unreleased]

[0.0.3] — 2014–08–09

Added

  • “Why should I care?” section mentioning The Changelog podcast.

[0.0.2] — 2014–07–10

Added

  • Explanation of the recommended reverse chronological release ordering.

0.0.1–2014–05–31

Added

  • This CHANGELOG file to hopefully serve as an evolving example of a  standardized open source project CHANGELOG.
  • CNAME file to enable GitHub Pages custom domain
  • README now contains answers to common questions about CHANGELOGs
  • Good examples and basic guidelines, including proper date formatting.
  • Counter-examples: “What makes unicorns cry?”
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment