Skip to content

Instantly share code, notes, and snippets.

View alexandrejulien's full-sized avatar

Alexandre JULIEN alexandrejulien

View GitHub Profile
@andreasonny83
andreasonny83 / RELEASE-NOTES.md
Last active July 19, 2024 13:31
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.