Skip to content

Instantly share code, notes, and snippets.

@promto-c
Created October 9, 2023 14:55
Show Gist options
  • Save promto-c/5c5a9fa5ec27d284ef594b9714027150 to your computer and use it in GitHub Desktop.
Save promto-c/5c5a9fa5ec27d284ef594b9714027150 to your computer and use it in GitHub Desktop.
Changelog Template (CHANGELOG.md) for User-Facing and Developer-Focused Changes

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.

Note:

  • Release Notes: Intended for end-users.
  • Internal Changes: Intended for developers working on this project.

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.

[Unreleased]

Release Notes

Added

  • ...

Changed

  • ...

Fixed

  • ...

Internal Changes

Refactored

  • ...

Technical Debt

  • ...

[Version Number] - YYYY-MM-DD

Release Notes

Added

  • ...

Changed

  • ...

Fixed

  • ...

Internal Changes

Refactored

  • ...

Technical Debt

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