Skip to content

Instantly share code, notes, and snippets.

View startkup-bot's full-sized avatar
🔥
Pursue Excellence, Build the Future Together!

Startkup 淡江大學新創社 startkup-bot

🔥
Pursue Excellence, Build the Future Together!
View GitHub Profile
@startkup-bot
startkup-bot / RELEASE-NOTES.md
Created January 23, 2023 16:19 — forked from andreasonny83/RELEASE-NOTES.md
Release Notes Template

Release Notes Template

Based off https://palantir.quip.com/pzRwAVr1bpzf

Pro-tip: look through the github diff between the previous release to see what's changed. The commit titles should give an outline of what's happened.

Upgrade Steps

  • List out, as concretely as possible, any steps users have to take when they upgrade beyond just dumping the dependency.
  • Write pseudocode that highlights what code should change and how.

Conventional Commit Messages

See how a minor change to your commit message style can make a difference. Examples

Have a look at CLI util git-conventional-commits to ensure this conventions and generate changelogs

Commit Formats

Default