Skip to content

Instantly share code, notes, and snippets.

View vishal-s-b's full-sized avatar

Vishal Singh Bhardvaj vishal-s-b

2 followers · 5 following
View GitHub Profile
@vishal-s-b
vishal-s-b / RELEASE-NOTES.md
Created July 19, 2024 13:31 — 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.
@vishal-s-b
vishal-s-b / README-Template.md
Created July 3, 2024 21:13 — forked from DomPizzie/README-Template.md
A simple README.md template

Project Title

Simple overview of use/purpose.

Description

An in-depth paragraph about your project and overview of use.

Getting Started