LaunchRanked
Launch free

Launch templateProduct and listing copy

Release notes template

Release notes tell the story of a notable version: what's new, why you built it and how to start using it. They're what you link from launch posts, store "What's New" fields and GitHub Releases. Put upgrade steps and known issues in plain view so people trust the rest.

Use it for

  • v1.0 launch.
  • Major versions and big features.
  • GitHub Releases and package registry releases.

Limits and rules

  • For developer packages, link release notes from the registry and repo; npm and PyPI pages show your README, so keep both in sync.

The template

Copy it, then replace everything in [BRACKETS]. Delete lines that don't apply rather than leaving them vague.

Release notes template
# [PRODUCT] [VERSION]: [HEADLINE - THE MAIN THING YOU CAN NOW DO]

Released [DATE]

## What's new
[2-3 SENTENCES ON THE MAIN CHANGE AND WHY IT MATTERS]

### [FEATURE 1]
[WHAT IT DOES, WHO IT'S FOR, SCREENSHOT OR CODE SAMPLE]

### [FEATURE 2]
[...]

## How to get it
[UPDATE INSTRUCTIONS: STORE UPDATE / npm install PRODUCT@VERSION / AUTOMATIC]

## Breaking changes
- [CHANGE] -> [WHAT TO DO]
(or: None.)

## Known issues
- [ISSUE] - [WORKAROUND]

## Thanks
[CONTRIBUTORS / TESTERS, WITH PERMISSION]

Full changelog: [LINK]

How to fill it in

  1. [HEADLINE]

    What users can do now, in plain words.

  2. Breaking changes

    Always present; write "None" if there aren't any.

  3. Known issues

    List them with workarounds.

Filled example

Fictional example. Paperlark is a fictional product we made up for these examples: an invoice-reminder tool for freelancers that sends polite follow-ups when a client pays late. Names, prices and details are invented to show the template filled in; they aren't a real company or real results.

Example (fictional product)
# Paperlark 2.0: reminders from your own email address

Released 2026-09-23

## What's new
Reminders can now send from your own Gmail or Outlook address, so clients see your name and reply straight to you. This was the most requested feature from beta users.

### Send from your own address
Connect Gmail or Outlook in Settings -> Sending. Reminders appear in your Sent folder.

### Pause reminders per client
Paused a project? Pause reminders for that client without deleting the invoice.

## How to get it
It's live for everyone. Connect your email in Settings -> Sending.

## Breaking changes
None.

## Known issues
- Outlook accounts with strict admin policies may need an admin to approve the connection.

## Thanks
Thanks to our 20 beta testers.

Full changelog: paperlark.example/changelog

(Fictional example.)

Do

  • Lead with the user benefit.
  • Include how to update.
  • Be explicit about breaking changes.
  • Link the full changelog.

Don't

  • Don't bury known issues.
  • Don't write only for engineers if users read it.
  • Don't list every minor fix; that's the changelog's job.

FAQ

What should release notes include?

What's new and why, how to get it, breaking changes, known issues and thanks.

Where should release notes go?

Your site, GitHub Releases for open-source, and a trimmed version in store What's New fields.

How are release notes different from a changelog?

Release notes tell the story of a notable version; the changelog is the complete running list.

Launch guides that use this template

Related templates

← All 25 launch templates