Skip to content

Instantly share code, notes, and snippets.

@KritikaSharmaKS
Created October 9, 2020 23:24
Show Gist options
  • Save KritikaSharmaKS/bee183c9283e1df9e7387e68b41248f5 to your computer and use it in GitHub Desktop.
Save KritikaSharmaKS/bee183c9283e1df9e7387e68b41248f5 to your computer and use it in GitHub Desktop.
Sample CHANGELOG.md

Changelog

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

Released

Semantic Version | Release 20XX | YYYY-MM-DD

Added

  • For any new features that have been added since the last version was released
  • [Issue Number](Link to your ISSUE) | Added this.
  • [Issue Number](Link to your ISSUE) | Added this too.

Changed

  • To note any changes to the software’s existing functionality
  • [Issue Number](Link to your ISSUE) | Changed this.

Deprecated

  • To note any features that were once stable but are no longer and have thus been removed

Fixed

  • Any bugs or errors that have been fixed should be so noted

Removed

  • This notes any features that have been deleted and removed from the software

Security

  • This acts as an invitation to users who want to upgrade and avoid any software vulnerabilities
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment