Skip to content

Instantly share code, notes, and snippets.

@sjimenez44
Created September 8, 2021 16:30
Show Gist options
  • Save sjimenez44/e3f059c08356aa539176b5167160ecc9 to your computer and use it in GitHub Desktop.
Save sjimenez44/e3f059c08356aa539176b5167160ecc9 to your computer and use it in GitHub Desktop.
Keep a CHANGELOG

Keep a CHANGELOG.md

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

  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

  ## [Unreleased]

  ## [0.0.1] - 2014-05-31
  ### Added
  - CNAME file to enable GitHub Pages custom domain

  [Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...HEAD
  [0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

Types of changes

  • 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.

KeepChangelog

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