Skip to content

Instantly share code, notes, and snippets.

@sblack4
Created May 14, 2018 22:41
Show Gist options
  • Save sblack4/8a5b637abdb272e8da44521af3ba38a1 to your computer and use it in GitHub Desktop.
Save sblack4/8a5b637abdb272e8da44521af3ba38a1 to your computer and use it in GitHub Desktop.
opinionated changelog template - CHANGELOG.md

changelog

https://keepachangelog.com/en/1.0.0/

A change log is kind of like a diary for contributers. In particular, it records:

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

ORIGIN

  • Vision for project
  • Resources used/to use
  • Any other information future humans will need to understand this repo!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment