Changelog

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

  • ✅ test

v1.0.0

Added

  • ✅ New visual identity by @tylerfortune8.
  • ✅ Version navigation.
  • ✅ Links to latest released version in previous versions.
  • ✅ "Why keep a changelog?" section.
  • ✅ "Who needs a changelog?" section.
  • ✅ "How do I make a changelog?" section.
  • ✅ "Frequently Asked Questions" section.
  • ✅ New "Guiding Principles" sub-section to "How do I make a changelog?".
  • ✅ Simplified and Traditional Chinese translations from @tianshuo.
  • ✅ German translation from @mpbzh & @Art4.
  • ✅ Italian translation from @azkidenz.
  • ✅ Swedish translation from @magol.
  • ✅ Turkish translation from @karalamalar.
  • ✅ French translation from @zapashcanon.
  • ✅ Brazilian Portugese translation from @Webysther.
  • ✅ Polish translation from @amielucha & @m-aciek.
  • ✅ Russian translation from @aishek.
  • ✅ Czech translation from @h4vry.
  • ✅ Slovak translation from @jkostolansky.
  • ✅ Korean translation from @pierceh89.
  • ✅ Croatian translation from @porx.
  • ✅ Persian translation from @Hameds.
  • ✅ Ukrainian translation from @osadchyi-s.

Changed

  • 📝 Start using "changelog" over "change log" since it's the common usage.
  • 📝 Start versioning based on the current English version at 0.3.0 to help
  • 📝 Rewrite "What makes unicorns cry?" section.
  • 📝 Rewrite "Ignoring Deprecations" sub-section to clarify the ideal
  • 📝 Improve "Commit log diffs" sub-section to further argument against
  • 📝 Merge "Why can’t people just use a git log diff?" with "Commit log
  • 📝 Fix typos in Simplified Chinese and Traditional Chinese translations.
  • 📝 Fix typos in Brazilian Portuguese translation.
  • 📝 Fix typos in Turkish translation.
  • 📝 Fix typos in Czech translation.
  • 📝 Fix typos in Swedish translation.
  • 📝 Improve phrasing in French translation.
  • 📝 Fix phrasing and spelling in German translation.

Removed

  • ❌ Section about "changelog" vs "CHANGELOG".

v0.3.0

Added

v0.2.0

Changed

  • 📝 Remove exclusionary mentions of "open source" since this project can

v0.1.0

Added

  • ✅ Answer "Should you ever rewrite a change log?".

Changed

  • 📝 Improve argument against commit logs.
  • 📝 Start following SemVer properly.

v0.0.8

Changed

  • 📝 Update year to match in every README example.
  • 📝 Reluctantly stop making fun of Brits only, since most of the world

Fixed

  • 🔨 Fix typos in recent README changes.
  • 🔨 Update outdated unreleased diff link.

v0.0.7

Added

  • ✅ Link, and make it obvious that date format is ISO 8601.

Changed

  • 📝 Clarified the section on "Is there a standard change log format?".

Fixed

  • 🔨 Fix Markdown links to tag comparison URL with footnote-style links.

v0.0.6

Added

  • ✅ README section on "yanked" releases.

v0.0.5

Added

  • ✅ Markdown links to version tags on release headings.
  • ✅ Unreleased section to gather unreleased changes and encourage note

v0.0.4

Added

  • ✅ Better explanation of the difference between the file ("CHANGELOG")

Changed

  • 📝 Refer to a "change log" instead of a "CHANGELOG" throughout the site

Removed

  • ❌ Remove empty sections from CHANGELOG, they occupy too much space and

v0.0.3

Added

  • ✅ "Why should I care?" section mentioning The Changelog podcast.

v0.0.2

Added

  • ✅ Explanation of the recommended reverse chronological release ordering.

v0.0.1

Added

  • ✅ This CHANGELOG file to hopefully serve as an evolving example of a
  • ✅ 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?"