Votelantern

Changelog template

A changelog is the running record of what changed in your software, version by version. Its readers want one thing: to find out, quickly, whether a release affects them. A good template makes that easy by putting the newest version on top and sorting every change under the same small set of headings, every time.

This template follows the style of Keep a Changelog, a published convention for changelog files (version 1.1.0 when we read keepachangelog.com on 11 November 2026). You can copy the markdown below into a CHANGELOG.md file, the name Keep a Changelog suggests, or open the template as a hosted changelog page.

The template, rendered

Example (fictional) Changelog in Keep a Changelog style
Leavewell is a fictional time-off tracker for small teams; the versions, dates and changes below are made up.

2.3.0: Half-day requests 2026-10-28

Staff can now book a morning or an afternoon off instead of a full day.

New

  • Half-day requests, morning or afternoon.
  • A team calendar view that shows half days as half blocks.

Improved

  • Managers see the remaining allowance before they approve a request.

Deprecated

  • The old weekly summary email will be replaced by the team calendar view in version 3.0.

2.2.1: Fixes for carried-over days 2026-10-09

Fixed

  • Days carried over from last year now show in the allowance on the first of the month.
  • Public holidays no longer count against allowance when they fall inside a longer request.

Security

  • Approval links in emails now expire after one use.

2.2.0: Team allowances 2026-09-17

Set a different yearly allowance for each team, instead of one for the whole company.

New

  • Per-team yearly allowances.

Improved

  • The request form remembers the last approver you picked.

Removed

  • The printable year planner, which few people opened; the team calendar view replaces it.

The sample product is Leavewell, a time-off tracker for small teams that we invented for this page. Its versions, dates and changes are all made up.

Open this in Votelantern

Opening it creates a changelog page in a free Votelantern account with these three example versions, ready for you to replace.

The structure

Each version gets its own entry, newest first, with:

Keep a Changelog itself uses "Added" and "Changed" for the first two headings; the other four are its own names. We use "New" and "Improved" because customers read them more easily. If your readers are developers who expect the original words, use them in your own markdown file; the hosted page keeps the template's headings.

Copy the markdown

For a CHANGELOG.md file in your repository, start from this:

# Changelog

All notable changes to this project are listed here, newest first.

## [2.3.0] - 2026-10-28
### New
- Half-day requests, morning or afternoon.
### Improved
- Managers see the remaining allowance before approving.
### Deprecated
- The weekly summary email; replaced in 3.0.

## [2.2.1] - 2026-10-09
### Fixed
- Carried-over days show on the first of the month.
### Security
- Approval links in emails expire after one use.

The example lines come from the made-up Leavewell product. Replace them with yours.

Writing each line

Changelog or release notes?

They overlap, and the words get used loosely. As we use them:

You might keep both: a changelog file for the full record, and release notes for announcements. If you'd rather start with release notes, the release notes template groups entries as New, Improved and Fixed for a non-technical reader.

Open this in Votelantern

This opens the release-notes version instead, with entries for a made-up dance-studio app.

From a file to a hosted page

A markdown file in a repository is fine for developers. Customers rarely open it. A hosted changelog page goes further in three ways in Votelantern:

  1. Entries link to requests. When an entry ships something customers asked for on your board, link the request. Publishing the entry moves it to Shipped.
  2. Voters hear about it. Everyone who voted and checked "Email me updates" gets an email that their request shipped, with an unsubscribe link.
  3. It shows up in your app. The widget has a "what's new" panel that shows recent entries without leaving your product.
Example (fictional) A "What's new" panel
Leavewell is a fictional time-off tracker for small teams; the versions, dates and changes below are made up.

What's new

Half-day requests 2026-10-28
Staff can now book a morning or an afternoon off instead of a full day.
Fixes for carried-over days 2026-10-09
Team allowances 2026-09-17
Set a different yearly allowance for each team, instead of one for the whole company.

A sample "what's new" panel (a static example) showing recent changelog entries the way your users would see them inside an app.

For a wider look at hosted options, see changelog software.

Plans for the hosted page (draft prices)

These are draft prices and could change. The changelog page, the widget and the "shipped" emails to voters come with the Free plan at $0, with a "Powered by Votelantern" badge on each. Team (price not set yet) adds a custom domain, identify users and a removable badge. Business (price not set yet) adds private boards and unlimited boards.

FAQ

Should every release get an entry, even a tiny one? Yes, if it has a version number. A one-line Fixed entry is fine. Gaps in the version list make readers wonder what they missed.

Where does an unreleased section go? Keep a Changelog suggests an "Unreleased" section at the top to track upcoming changes, which you move into a new version's section at release time. Our hosted template leaves it out, since every entry there has a release date; add it in your markdown file if you use one.

Can I use this template without version numbers? Yes. Use the release date as the heading instead. Version numbers help when customers run different versions; a hosted web app that everyone uses at once can do without them.

Do I need an HTML changelog template? Not if you use a hosted page: Votelantern renders the changelog as a web page for you. If you build your own site, the markdown above converts to HTML with any markdown tool.

All templates and guides