Skip to content

Instantly share code, notes, and snippets.

@The-EDev

The-EDev/CHANGELOG_TEMPLATE.md

Created April 7, 2021 13:50
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save The-EDev/09ae14ee2afecea27d23adc5c844de51 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save The-EDev/09ae14ee2afecea27d23adc5c844de51 to your computer and use it in GitHub Desktop.
Download ZIP
my own template for creating a changelog
Raw
CHANGELOG_TEMPLATE.md

MyProject Changelog

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

The format is inspired by BUT NOT BASED ON Keep a Changelog.

versioning is Major.Minor+Patch Where: Major: Release status, involves revamping large sections of the codebase (or whether the project is ready for production). Minor: any change that is not major, API breaking changes included. Patch: we messed a release up and really need to fix an issue or 2.

[Master] - yyyy-mm-dd

This is where changes that have been merged into master branch, but have not been released under a version yet. They're sorted chronologically.

  • Bug PR title goes here. #ISSUES - #PR
  • Feature PR title doesn't work. Has been replaced with short description #ISSUES - #PR

[1.2] - 2020-03-15

This is what the version is about, any notes go here. It is sorted by importance (I know it's subjective, I don't care). The sections are sorted alphabetically.

Subject 1

Subject 2

Unit Tests

[1.1+45] - 2020-03-14

Quick patch because someone wrote 'hug' instead of 'bug'

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