Skip to content

Instantly share code, notes, and snippets.

@XBWGC
XBWGC / RELEASE-NOTES.md
Created October 24, 2022 03:04 — 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.