Skip to content

Instantly share code, notes, and snippets.

@kenjij

kenjij/CHANGELOG.md

Created December 29, 2016 09:12
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kenjij/e0586f1445eee76353d65381fe7ae10e to your computer and use it in GitHub Desktop.
Save kenjij/e0586f1445eee76353d65381fe7ae10e to your computer and use it in GitHub Desktop.
Download ZIP
A change log template
Raw
CHANGELOG.md

1.0.0 / Unreleased

Added

  • Version followed by release date.
  • Maintain "Unreleased" version in draft in preparation for release.
  • "Added" section for new features added.
  • MAJOR increment in semantic versioning would mean incompatible changes.

Changed

  • "Changed" section may benefit from keywords wrapped in square brackets.
  • [BUGFIX] For bug fixes.
  • [PERFORMANCE] Improved performances.
  • [SECURITY] Vulnerability fixes.

Deprecated

  • Features to be removed in upcoming releases.

Removed

  • Deprecated features removed in this release.

0.5.1 / YYYY-MM-DD

Changed

  • Release date in ISO 8601.
  • [BUGFIX] PATCH increment in semantic versioning would generally mean just bug fixes.

Deprecated

  • Features to be removed in upcoming releases.

0.5.0 / 2016-12-28

Added

  • MINOR increment in semantic versioning would mean backwards-compatible features added.

Changed

  • [PERFORMANCE] Or possibly a tweaked algorithm.
  • [SECURITY] Even a security patch thrown in together.

Deprecated

  • Features to be removed in upcoming releases.

Removed

  • Deprecated features removed in this release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment