Skip to content

Instantly share code, notes, and snippets.

@Karlbovski

Karlbovski/CHANGELOG.md

Last active June 5, 2021 09:59
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Karlbovski/4a9cb3ee4df48bfff3f6c61f433da025 to your computer and use it in GitHub Desktop.
Save Karlbovski/4a9cb3ee4df48bfff3f6c61f433da025 to your computer and use it in GitHub Desktop.
Download ZIP
Template for a well structured changelog
Raw
CHANGELOG.md

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.

QuickTip - Generate a quick changelog from git commits ;)

git log --pretty="- %s" > CHANGELOG.md

[Unreleased]

Track upcoming changes

The Unreleased section serves two purposes:

  • People can see what changes they might expect in upcoming releases
  • At release time, you can move the Unreleased section changes into a new release version section.

[0.0.1] Jan 1, 2020

Added

(new features)

Changed

(changes in existing functionality)

Deprecated

(soon-to-be removed features)

Removed

(now removed features)

Fixed

(any bug fixes)

Known Issues

(aware they are in this release)

Security

(in case of vulnerabilities)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment